Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/readme #231

Merged
merged 7 commits into from
May 16, 2023
Merged

Update/readme #231

merged 7 commits into from
May 16, 2023

Conversation

jeffpaul
Copy link
Member

Description of the Change

This adds some user-friendly intro details to the readmes as well as adds a GIF demo and reorders the screenshots to move the settings page to the end (as that's least helpful to show versus HOW the plugin works).

How to test the Change

Use the GitHub web markdown previewer.

Changelog Entry

Changed - Updated documentation.

Credits

Props @jeffpaul

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@jeffpaul jeffpaul added this to the 1.4.0 milestone May 10, 2023
@jeffpaul jeffpaul self-assigned this May 10, 2023
@jeffpaul jeffpaul requested a review from iamdharmesh as a code owner May 10, 2023 17:02
@github-actions github-actions bot added the needs:code-review This requires code review. label May 10, 2023
Copy link
Member

@iamdharmesh iamdharmesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @jeffpaul. Updated details in readme files seem very user-friendly and informative, Thanks for improving it.

I just added 2 minor notes related to recent updates we made to keep this information to its latest. Could you please check it once?

.wordpress-org/screenshot-3.gif Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
readme.txt Outdated Show resolved Hide resolved
@jeffpaul jeffpaul mentioned this pull request May 11, 2023
17 tasks
@jeffpaul jeffpaul requested a review from iamdharmesh May 15, 2023 22:14
@iamdharmesh iamdharmesh merged commit 66920f6 into develop May 16, 2023
@iamdharmesh iamdharmesh deleted the update/readme branch May 16, 2023 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:code-review This requires code review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants