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

Improve documentation #1

Open
mjwwit opened this issue Feb 26, 2019 · 0 comments
Open

Improve documentation #1

mjwwit opened this issue Feb 26, 2019 · 0 comments

Comments

@mjwwit
Copy link
Owner

mjwwit commented Feb 26, 2019

Documentation should reside in the README (for now) and contain an extensive API reference including code samples and gotchas.

Additionally, there should be a section with common cases/issues and their recommended solutions.

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

1 participant