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

Merged
merged 4 commits into from
Nov 21, 2017
Merged

Update readme #51

merged 4 commits into from
Nov 21, 2017

Conversation

inveterateliterate
Copy link
Contributor

@inveterateliterate inveterateliterate commented Nov 8, 2017

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

Copy link

@dpikt dpikt left a 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.

Copy link

@rkillackey rkillackey left a 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

@inveterateliterate
Copy link
Contributor Author

I'm good with removing the motivation stuff. We can always use that in promotional communications.

@dpikt
Copy link

dpikt commented Nov 20, 2017

@inveterateliterate changes look good to me! I'd say merge away unless @francirp has any extra input.

@francirp
Copy link
Contributor

LGTM! Merge away.

Copy link

@dpikt dpikt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@inveterateliterate inveterateliterate merged commit a7b2206 into master Nov 21, 2017
@inveterateliterate inveterateliterate deleted the update-readme branch November 21, 2017 16:19
@inveterateliterate inveterateliterate mentioned this pull request Nov 21, 2017
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.

4 participants