Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Better README.md #1

Open
natnat-mc opened this issue Oct 27, 2021 · 0 comments
Open

Better README.md #1

natnat-mc opened this issue Oct 27, 2021 · 0 comments
Assignees
@natnat-mc
Labels
documentation Improvements or additions to documentation

Comments

@natnat-mc
Copy link
Owner

  • add an image of the running program
  • add a reference to config.lua
  • add the CLI arg docs
  • document the public interface of the config file
  • document the public interface of probes
  • list the dependencies
@natnat-mc natnat-mc added the documentation Improvements or additions to documentation label Oct 27, 2021
@natnat-mc natnat-mc self-assigned this Oct 27, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@natnat-mc natnat-mc

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@natnat-mc