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

Write formal documentation #26

Open
leonelquinteros opened this issue Aug 14, 2018 · 0 comments
Open

Write formal documentation #26

leonelquinteros opened this issue Aug 14, 2018 · 0 comments

Comments

@leonelquinteros
Copy link
Owner

Please describe your issue

The only documentation for this package is Godoc and the README.md file from this repo. We need to write better docs, some tutorial and use case examples to make package adoption easier.

Is this a bug, an improvement, a proposal or something else? Describe it.

Improvement

What's the expected behaviour, the current behaviour and the steps to reproduce it?

We don't have documentation. We want to have documentation

Comments

Decide between a Github page or the Wiki for this.

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

No branches or pull requests

1 participant