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 #559

Merged
merged 8 commits into from
Feb 23, 2024
Merged

Update/readme #559

merged 8 commits into from
Feb 23, 2024

Conversation

jeffpaul
Copy link
Collaborator

Description of the Change

This PR reorganizes the README.md file and merges in the "WIP" documentation sections into the normal flow of the readme. Documentation is, unfortunately, always a work in progress so it seemed better to pull that content in as-is and we can continue to iterate from there.

This PR also makes use of the nametag image from GatherPress.org and turns it into the WP.org plugin icon image and includes the various versions for publishing on WP.org.

This PR also pulls in the demo video from earlier this month on GatherPress.org in hopes of rendering that in the README.md to give folks a good demo/preview in GitHub as well.

Still needed is:

  • Update the description of the GatherPress repo from the No description, website, or topics provided. placeholder to GatherPress, powering our community's event management needs. or something like that.
  • Generate a plugin header image and add to the repo (.wordpress-org folder so they'll get deployed to WP.org on the next release published there)
  • Generate some plugin screenshots and add those to the repo and reference in the readme files

Closes #50, #406.

How to test the Change

Use the GitHub markdown previewer to see the file changes.

Changelog Entry

Added - Plugin icon files.
Changed - Updated documentation within readme files.

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.

@mauteri mauteri merged commit 19e928f into GatherPress:main Feb 23, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refresh the README Phrasing
2 participants