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

Update the README.md #4

Open

typedef42 opened this issue Sep 14, 2016 · 1 comment

Labels

Milestone

Collaborator

typedef42 commented Sep 14, 2016

Update the readme.md with quick start usage, and examples.
also add badges (contributors, build success, npm etc)

typedef42 added the documentation label

typedef42 added this to the 1.0.0 milestone

Collaborator Author

typedef42 commented Feb 23, 2017

Instead of just a readme, we should have a doc folder with class.md docs, and then put it in readme.io

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