A simple and effective README.md template for all your github projects.
Table of content
TODO: Describe why this project exists
TODO: Screenshots of the app
Installation & Usage
TODO: Describe the installation process as below and delete this line
- Step 1 details here
- Step 2 details here
- Step 3 details here
TODO: Write usage instructions as below and delete this line
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
TODO: Write history as below and delete this line
TODO: Write credits as below and delete this line
See the LICENSE file in this project's directory.