info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 10:02:41 +02:00
Code Issues Releases Wiki Activity

Added Usage

Browse Source
This commit is contained in:
Kyle Lobo
2019-06-08 00:17:06 +05:30
committed by GitHub
parent e9659b7f5b
commit 4ce268a7ea
1 changed files with 20 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README Templates/Standard.md
View File

@@ -21,14 +21,15 @@
</p>
## 📝 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 <a name = "about"></a>
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 <a name = "tests"></a>
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 <a name = "deployment"></a>
## 🎈 Usage <a name="usage"></a>
Add notes about how to use the system.
## 🚀 Deployment <a name = "deployment"></a>
Add additional notes about how to deploy this on a live system.
## ⛏️ Built Using <a name = "built_using"></a>
+ [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 <a name = "authors"></a>
+ [@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 <a name = "acknowledgement"></a>
+ Hat tip to anyone whose code was used
+ Inspiration
+ References
- Hat tip to anyone whose code was used
- Inspiration
- References