Add some examples and usage details in the readme.

Open bsutton opened this issue 5 years ago • 2 comments

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.

Jan 10 '20 20:01 bsutton

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.

Dec 27 '22 09:12 juandelgado

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

May 30 '23 11:05 Laur1nMartins