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.

Sign up for GitHub

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

Jump to bottom

Expose the API and simple examples at first in the README #1

Open

vvo opened this issue Feb 22, 2016 · 0 comments

vvo commented Feb 22, 2016

The project could be easier to understand by having a more API focused README:

show a simple example. Not doing an export, just using the API and showing what are the main features of the lib
detail the API right away
maybe explain the problem in a blogpost rather than in the README

What do you think?

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