diff --git a/README Templates/Standard.md b/README Templates/Standard.md index 6a569fe..eb5827d 100644 --- a/README Templates/Standard.md +++ b/README Templates/Standard.md @@ -21,14 +21,15 @@
## 📝 Table of Contents -+ [About](#about) -+ [Getting Started](#getting_started) -+ [Deployment](#deployment) -+ [Built Using](#built_using) -+ [TODO](../TODO.md) -+ [Contributing](../CONTRIBUTING.md) -+ [Authors](#authors) -+ [Acknowledgments](#acknowledgement) +- [About](#about) +- [Getting Started](#getting_started) +- [Deployment](#deployment) +- [Usage](#usage) +- [Built Using](#built_using) +- [TODO](../TODO.md) +- [Contributing](../CONTRIBUTING.md) +- [Authors](#authors) +- [Acknowledgments](#acknowledgement) ## 🧐 About Write about 1-2 paragraphs describing the purpose of your project. @@ -37,7 +38,6 @@ Write about 1-2 paragraphs describing the purpose of your project. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. ### Prerequisites - What things you need to install the software and how to install them. ``` @@ -45,7 +45,6 @@ Give examples ``` ### Installing - A step by step series of examples that tell you how to get a development env running. Say what the step will be @@ -63,11 +62,9 @@ until finished End with an example of getting some data out of the system or using it for a little demo. ## 🔧 Running the tests - Explain how to run the automated tests for this system. ### Break down into end to end tests - Explain what these tests test and why ``` @@ -75,30 +72,30 @@ Give an example ``` ### And coding style tests - Explain what these tests test and why ``` Give an example ``` -## 🚀 Deployment +## 🎈 Usage +Add notes about how to use the system. +## 🚀 Deployment Add additional notes about how to deploy this on a live system. ## ⛏️ Built Using -+ [MongoDB](https://www.mongodb.com/) - Database -+ [Express](https://expressjs.com/) - Server Framework -+ [VueJs](https://vuejs.org/) - Web Framework -+ [NodeJs](https://nodejs.org/en/) - Server Environment +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [VueJs](https://vuejs.org/) - Web Framework +- [NodeJs](https://nodejs.org/en/) - Server Environment ## ✍️ Authors - -+ [@kylelobo](https://github.com/kylelobo) - Idea & Initial work +- [@kylelobo](https://github.com/kylelobo) - Idea & Initial work See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project. ## 🎉 Acknowledgements -+ Hat tip to anyone whose code was used -+ Inspiration -+ References +- Hat tip to anyone whose code was used +- Inspiration +- References