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

docs could be a bit easier to follow for newer developer #84

Open
DanHitt opened this issue Mar 19, 2016 · 1 comment
Open

docs could be a bit easier to follow for newer developer #84

DanHitt opened this issue Mar 19, 2016 · 1 comment

Comments

@DanHitt
Copy link
Contributor

DanHitt commented Mar 19, 2016

Thanks for creating this, it saved me tons of time as you pointed out but (being new) it did take me a while to figure out how to use it. I was so happy to find something to autopopulate for me, I can't tell you how much i wanted to hug you.

I've forked and cleaned up the readme just a bit and added a bit to the examples to make them a little more clear to new devs. I'd like to submit a pull!

Thanks again!

@gregmuellegger
Copy link
Owner

Thanks for the good feedback! :) It's indeed a little more complex to use than it needs to be, I haven't changed the API since 6 years though.

A pull request for making docs better and easier to understand would be super awesome! Thanks for offering the help. It's always tricky to know how to make something approachable for newcomers if you already know the project quite well :)

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

No branches or pull requests

2 participants