1- ## Project
1+ ## Project name
22
3- Description: What does this project do and who does it serve?
3+ A description of what this project does and who it serves.
44
55Include authorship, support contact and release information.
66
7- ## Project Setup, Installation, and Configuration
7+
8+ ## Project setup, installation, and configuration
9+
810How do I, as a developer, start working on the project?
911
10121 . What dependencies does it have (where are they expressed) and how do I install them?
11131 . Can I see the project working before I change anything?
1214
15+
1316## Testing
17+
1418How do I run the project's automated tests?
1519
1620* Unit Tests
1721
1822* Integration Tests
1923
24+
2025## Deploying
2126
2227### How to setup the deployment environment
@@ -27,19 +32,22 @@ How do I run the project's automated tests?
2732
2833### How to deploy
2934
30- ## Troubleshooting & Useful Tools
35+
36+ ## Troubleshooting & useful tools
3137
3238### Examples of common tasks
3339
34- > e.g.
35- > * How to make curl requests while authenticated via oauth.
36- > * How to monitor background jobs.
37- > * How to run the app through a proxy.
40+ e.g.
41+ * How to make curl requests while authenticated via oauth.
42+ * How to monitor background jobs.
43+ * How to run the app through a proxy.
44+
3845
3946## Contributing changes
4047
41- * See CONTRIB.md
48+ * See [ CONTRIB.md] ( CONTRIB.md )
49+
4250
4351## Licensing
4452
45- * See LICENSE
53+ * See [ LICENSE] ( LICENSE )
0 commit comments