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

Initial Better README #118

Merged
merged 3 commits into from
Mar 20, 2014
Merged

Initial Better README #118

merged 3 commits into from
Mar 20, 2014

Conversation

simeonwillbanks
Copy link
Contributor

Fixes #112

  • Reorganize sections into logical hierarchy
  • Add table of contents to each section
  • Stub Rails, Sinatra, and Command Line example sections

@jch @rsanheim Again, we can collaboratively edit until mergeable.

- Reorganize sections into logical hierarchy
- Add table of contents to each section
- Stub Rails, Sinatra, and Command Line example sections
- [Command Line](#command-line)
- [Filters](#filters)
- [Dependencies](#dependencies)
- [Documentation](#documentation)
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 like the table of contents on the top for navigating this large readme. I think filters, dependencies, and documentation should be top-level sections rather than nested within the usage section.

@simeonwillbanks
Copy link
Contributor Author

@jch comments addressed... ready to 🚢?

@jch
Copy link
Contributor

jch commented Mar 20, 2014

👍 🚢

simeonwillbanks pushed a commit that referenced this pull request Mar 20, 2014
@simeonwillbanks simeonwillbanks merged commit f5d51b4 into master Mar 20, 2014
@simeonwillbanks simeonwillbanks deleted the better-readme branch March 20, 2014 15:18
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.

Getting Started Guide
2 participants