Fix README formatting to pretty preview it on GitHub#119
Open
Dinika wants to merge 9 commits intobeaulebens:trunkfrom
Open
Fix README formatting to pretty preview it on GitHub#119Dinika wants to merge 9 commits intobeaulebens:trunkfrom
Dinika wants to merge 9 commits intobeaulebens:trunkfrom
Conversation
This super short PR is only meant to help improve developer experience. The README is shown as plain-text currently on the github home page which is a bit difficult to read (imho). This PR changes the Readme to `rst` format which github can preview. Having a pretty preview will help develolpers quickly glean over the document and find the stuff that they want.
Change readme format so it is pretty-previewed on github
Make readme rst format compliant for pretty preview on github
Format changelog in README to be rst compliant
pablinos
reviewed
Mar 11, 2025
Collaborator
pablinos
left a comment
pablinos
left a comment
There was a problem hiding this comment.
Thanks for working on this. I agree that having the Readme render in GitHub is a useful quality of life fix. This readme.txt file is required for the wordpress.org plugin directory.
We could have both perhaps? Or add something that generates one from the other, which could be used as part of the deployment process.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This super short PR is only meant to help improve developer experience.
Currently the README is shown as plain-text on the github home page which is a bit difficult to read (imho).
Judging by the text in README, I guess that it is written in rst format (please correct me if I am wrong).
Motivation
Having a pretty preview will help develolpers quickly glean over the document and find the stuff that they want.
So, I have made the following changes that help show the pretty preview of README in tools like Github:
rstThe text content of README is not changed and here is a screenshot of how this previews on GitHub:
Some context
I have just discovered and used the keyring plugin for the first time as a trialmattician at automattic. I quite liked the abstraction that the plugin provides and in the course of finding documentation, I found this repository.