diff --git a/README Templates/Standard.md b/README Templates/Standard.md index deb3a0e..a7f2270 100644 --- a/README Templates/Standard.md +++ b/README Templates/Standard.md @@ -2,6 +2,7 @@ Project logo

+

Project Title

@@ -19,7 +20,7 @@

-# Table of Contents +# 📝 Table of Contents + [About](#about) + [Getting Started](#getting_started) + [Deployment](#deployment) @@ -29,10 +30,10 @@ + [Authors](#authors) + [Acknowledgments](#acknowledgement) -## About +## 🧐 About Write about 1-2 paragraphs describing the purpose of your project. -## Getting Started +## 🏁 Getting Started 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 @@ -61,7 +62,7 @@ until finished End with an example of getting some data out of the system or using it for a little demo. -## Running the tests +## 🔧 Running the tests Explain how to run the automated tests for this system. @@ -81,23 +82,23 @@ Explain what these tests test and why Give an example ``` -## Deployment +## 🚀 Deployment Add additional notes about how to deploy this on a live system. -## Built With +## ⛏️ Built With + [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 +## ✍️ Authors + [@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 +## 🎉 Acknowledgements + Hat tip to anyone whose code was used + Inspiration + References