.
Name of your library
[Poster for your library if available]
Or any other badge with teal color. You can customise your own here.
Short (2-5 lines) description of your solution.
Main features
Describe why people should use your library. Ideally, you should show 10x feature why your library is better than competitor's ones
Installation
Describe how people can install your library
Requirements
Define here min SDK or extra tools needed to be installed for the correct library work.
Usage
Describe in details how to use your library. This is the most important section of the readme, because if user won't understand how to use it, such library won't help people.
Documentation
If your library is pretty big and you would like to split documentation by pages - create Wiki and leave here links for pages.
Contributing
Pull requests are welcome! We'd love help improving this library. Feel free to browse through open issues to look for things that need work. If you have a feature request or bug, please open a new issue so we can track it.