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

Add proper user documentation #53

Open

rcmachado opened this issue Jan 8, 2020 · 0 comments

Owner

rcmachado commented Jan 8, 2020 •

edited

Currently our documentation is very basic - only the README - and doesn't cover all commands nor provide much examples.

We need to improve this so it's easier for someone who wants to use the tool. The docs could have:

Explanation and examples for all commands
Examples of specific uses - eg. prepare a release

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