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

Add some examples and usage details in the readme. #54

Open
bsutton opened this issue Jan 10, 2020 · 2 comments
Open

Add some examples and usage details in the readme. #54

bsutton opened this issue Jan 10, 2020 · 2 comments
Labels
good first issue A good starting issue for contributors (issues with this label will appear in /contribute) type-enhancement A request for a change that isn't a bug

Comments

@bsutton
Copy link

bsutton commented Jan 10, 2020

Just came across this project.
Its a little too hard to start using as I'm having to read code on git to see what it does and doesn't do.

Some example usages in the readme would help potential users evaluate if it will suit their purpose and speed up the process of integrating your package into a project.

@jonasfj jonasfj added type-enhancement A request for a change that isn't a bug good first issue A good starting issue for contributors (issues with this label will appear in /contribute) labels Nov 22, 2021
@juandelgado
Copy link

In case someone swings by, I've opened a PR with a very simple addition to the README on how to use the library, see #87.

Hope it helps.

@Laur1nMartins
Copy link

Having that really helps! Hopefully this will be added to the readme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good starting issue for contributors (issues with this label will appear in /contribute) type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

4 participants