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 #15

Open
TimWhiting opened this issue Nov 14, 2020 · 2 comments
Open

Improve README #15

TimWhiting opened this issue Nov 14, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation medium priority

Comments

@TimWhiting
Copy link
Collaborator

Essentially link to the website where there will be more information, but have a simple getting started, and example section for a quick intro on how to use it. Also document the progress of the library.
@TimWhiting
Copy link
Collaborator Author

Related to #5 and #6, but those pertain to the actual website.

@TimWhiting TimWhiting added the documentation Improvements or additions to documentation label Nov 14, 2020
@TimWhiting
Copy link
Collaborator Author

Just need more detail, and a more complete example probably on README now.

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 medium priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TimWhiting