Update README.md for v3#170
Merged
Merged
Conversation
zenhack
approved these changes
May 12, 2021
zenhack
left a comment
Contributor
There was a problem hiding this comment.
Looks reasonable to me; a couple comments in-line but nothing I'd block over.
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
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.
I've taken the liberty of cleaning up the README a bit in preparation for
v3. In particular, certain details of the installation process are no longer relevant with the upcoming switch to modules (see: #165, #166).Additionally, I've made some rather opinionated changes with respect to "marketing" (or -- if you prefer -- with respect to the ordering of information by priority). I'm of the opinion that README's should first and foremost answer the question "what is this software, and is it for me?". The answers to these questions are somewhat scattered and buried below technical details, which IMHO only become relevant after the initial what/why questions have been answered.
My basic approach can be summarized as follows:
Feedback very much welcome.
P.S.: I added a couple of badges because nothing says "serious project" like badges. Devs love badges. 😝