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

Improve README #14

Open
sumeetkoli opened this issue Jan 21, 2023 · 0 comments
Open

Improve README #14

sumeetkoli opened this issue Jan 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sumeetkoli
Copy link
Collaborator

Improve README doc.
Things that can be added:

  1. Description and purpose
  2. Getting started guide
  3. Contributing guide
  4. API doc link
@sumeetkoli sumeetkoli added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 21, 2023
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
1 participant
@sumeetkoli