-
Notifications
You must be signed in to change notification settings - Fork 1
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 #51
Update readme #51
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! My one suggestion would be to switch the order of the Details
and Advanced
sections.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Agreed with David about switching the sections. I also think it's still a bit long...might consider removing the Motivation section? It seems like that content was communicated across other sections
I'm good with removing the motivation stuff. We can always use that in promotional communications. |
@inveterateliterate changes look good to me! I'd say merge away unless @francirp has any extra input. |
LGTM! Merge away. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Largely reorganized the ReadMe to bring up the installation and usage, and leave the "philosophy" to the end.
Appreciate any other thoughts on organization, or whether the
Motivation
section should be less philosophy and more just on value add, or something like that.I did update some of the writing itself, so please do read through.
Resolves #50