INSTALL | USAGE | API | AUTHOR | CONTRIBUTE | LICENSE | SUPPORT
KISS - Keep it simple, stupid!
Quick usage example...
...repeat until it gets clear.
Description of the problem that your module solves.
A brief note on environment/machine/tools requisites
Installation/deployment example
Give more elaborate example here.
Api description should be given here.
Code examples ...
You can follow me on twitter or just email me.
List of people and project that inspired creation of this one:
- @PurpleBooth for his readme template posted here
- @jxson for his readme example as well.
- Github guides for their precious documenting your project article concerning readme creation
Check out (if any) contribution guide or license for more details.
You should be aware that this project is supported solely by me and provided as is.
If you want to become a patron or offer me a support please follow here.
Go back to the project description
Copyright © 2017 Davronov Alexander