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 README.md #42

Open
4 of 5 tasks
zivnevo opened this issue Nov 20, 2022 · 0 comments
Open
4 of 5 tasks

Improve README.md #42

zivnevo opened this issue Nov 20, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@zivnevo
Copy link
Member

zivnevo commented Nov 20, 2022

  • Better explain the capabilities this code offers
  • Include Usage section, showing how to run from command-line
  • Include examples of outputs
  • Include Build section with details how to build the project
  • Provide some details how to consume as a Go library
@zivnevo zivnevo added the documentation Improvements or additions to documentation label Nov 20, 2022
@adisos adisos self-assigned this Dec 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants