doc: improve readme to more clearly state the lib purpose, pros and cons#116
Merged
doc: improve readme to more clearly state the lib purpose, pros and cons#116
Conversation
The readme file is what (prospective) users check out first. As it was, it didn't make it easy to identify key features of the library as it consisted of a large prose paragraph followed by long code examples. This change makes several improvements to the readme structure to make it more appealing and easier to identify the value proposition of the library. Namely: - Collapse code examples - Add a one sentence description of the library - List key features as bullet point so they are easily discoverable - Add a "when to use" section to allow quick decision making Signed-off-by: Robin Hahling <[email protected]>
rolinh
added
area/documentation
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.
The readme file is what (prospective) users check out first. As it was, it didn't make it easy to identify key features of the library as it consisted of a large prose paragraph followed by long code examples.
This change makes several improvements to the readme structure to make it more appealing and easier to identify the value proposition of the library. Namely:
I think this is overall a good improvement and it definitely makes it more "catchy". Feedback welcome!