A simple README.md template for your github projects.
TODO: Describe why this project exists
TODO: Screenshots of the app
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 -m 'Added 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
22/05/19: v1 published to github.
08/06/22: v2 updated an error in the 'Contributing' section and added examples of project 'History'.
TODO: Write credits as below and delete this line
- Name of person
- Template for this README is template-readme created by Zain Khan
See the LICENSE file in this project's directory.