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.

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

[FEATURE] Improve README.md which more information about usage #14

Closed
1 task
gdegiorgio opened this issue Oct 28, 2024 · 1 comment
Closed
1 task

[FEATURE] Improve README.md which more information about usage #14

gdegiorgio opened this issue Oct 28, 2024 · 1 comment
Assignees
@gdegiorgio
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@gdegiorgio
Copy link
Owner

Description

We should provide more info in README about systatus usage, like configuration.

Problem Statement

README.md provides too little infos about usage

Proposed Solution

Maybe add more info about exposed routes and how they works, a nice to have would be to implement more example based on common libraries/framework (chi, gorilla...)

Acceptance Criteria

  • README.md contains more infos about project usage
@gdegiorgio gdegiorgio added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 28, 2024
@gdegiorgio gdegiorgio self-assigned this Nov 27, 2024
@gdegiorgio
Copy link
Owner Author

This issue has been closed in #38

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

@gdegiorgio gdegiorgio

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gdegiorgio