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

Add better documentation #1

Open
Pradhvan opened this issue Jan 31, 2020 · 1 comment
Open

Add better documentation #1

Pradhvan opened this issue Jan 31, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Pradhvan
Copy link
Contributor

Currently, the documentation is written in the README.md file and only gives the basic use case of the library. Better documentation can be hosted somewhere like Read the Docs and would have installation guidelines, examples, contribution guidelines and other related things to the library.
@pm1122
Copy link

pm1122 commented Mar 12, 2020

J

@Pradhvan Pradhvan added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Pradhvan @pm1122