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.

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

Readme expansion/cleanup #91

Open
kcoleman731 opened this issue May 19, 2021 · 0 comments
Open

Readme expansion/cleanup #91

kcoleman731 opened this issue May 19, 2021 · 0 comments

Comments

@kcoleman731
Copy link
Collaborator

We need to update our readme to make the project more self service and "official". Things we need to update.

Project description and value proposition. Explain "what it is" and "why I should use it".
Add links to relevant documentation section in the project (i.e. the /docs dir).
Fix sample code.
Remove or complete TODOs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant