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

Getting Started Guide #112

Closed
simeonwillbanks opened this issue Feb 7, 2014 · 2 comments · Fixed by #118
Closed

Getting Started Guide #112

simeonwillbanks opened this issue Feb 7, 2014 · 2 comments · Fixed by #118

Comments

@simeonwillbanks
Copy link
Contributor

The README has tons of information (usage, dependencies, examples, etc). However, new users would benefit from a Getting Started Guide; factory_girl's guide is a good example. The Getting Started Guide could detail common implementations such as integrating with Rails or Sinatra. Thoughts?

@jch
Copy link
Contributor

jch commented Feb 21, 2014

I think this is a pretty simple and small gem. To keep the number of files from growing, I'd rather we organize the information better in the README so users don't have to jump around so much. A table of contents might be a good start as the doc grows longer.

@simeonwillbanks
Copy link
Contributor Author

👍 Better README 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants