Currently it is not 100% clear what exactly the project does, just by scanning through the first few sentences of README.md. Also, the docs are missing some important notes on common pitfalls.
I want to address both by some restructuring and more examples within the README.md.
Currently it is not 100% clear what exactly the project does, just by scanning through the first few sentences of README.md. Also, the docs are missing some important notes on common pitfalls.
I want to address both by some restructuring and more examples within the README.md.