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

Write Documentation #6

Open
serwarde opened this issue Mar 19, 2024 · 0 comments
Open

Write Documentation #6

serwarde opened this issue Mar 19, 2024 · 0 comments
Assignees
@serwarde
Labels
📖 Documentation Improvements or additions to documentation

Comments

@serwarde
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
The instructions on how to use the package right now are limited to the README file.

Describe the solution you'd like
Write a more comprehensive documentation on what the package is, what it does, and how to use it. And, ideally, update the documentation regularly with new releases.

Describe alternatives you've considered
Updating the README and using the wiki in the Github repo.
@serwarde serwarde added the 📖 Documentation Improvements or additions to documentation label Mar 19, 2024
@serwarde serwarde self-assigned this Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@serwarde serwarde

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

No branches or pull requests
1 participant
@serwarde