Description of the project: What is its purpose, what can you accomplish using it?
How would you install the project?
How do you use the project? E.g. what methods are exposed for usage, where can you find more information about the API, what parameters does the CLI take?
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.