Skip to content

Commit 6f64f89

Browse files
authored
Enhance README with project details and instructions
Expanded README with project description, getting started guide, and author information.
1 parent 2c7db9a commit 6f64f89

File tree

1 file changed

+58
-10
lines changed

1 file changed

+58
-10
lines changed

README.md

Lines changed: 58 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,62 @@
1-
# Start all services
2-
docker-compose up
1+
# Project Title
32

4-
# Start in detached mode
5-
docker-compose up -d
3+
Simple overview of use/purpose.
64

7-
# Rebuild containers
8-
docker-compose up --build
5+
## Description
96

10-
# Stop all services
11-
docker-compose down
7+
An in-depth paragraph about your project and overview of use.
128

13-
# Stop and remove volumes (clean slate)
14-
docker-compose down -v
9+
## Getting Started
10+
11+
### Dependencies
12+
13+
* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
14+
* ex. Windows 10
15+
16+
### Installing
17+
18+
* How/where to download your program
19+
* Any modifications needed to be made to files/folders
20+
21+
### Executing program
22+
23+
* How to run the program
24+
* Step-by-step bullets
25+
```
26+
code blocks for commands
27+
```
28+
29+
## Help
30+
31+
Any advise for common problems or issues.
32+
```
33+
command to run if program contains helper info
34+
```
35+
36+
## Authors
37+
38+
Contributors names and contact info
39+
40+
ex. Dominique Pizzie
41+
ex. [@DomPizzie](https://twitter.com/dompizzie)
42+
43+
## Version History
44+
45+
* 0.2
46+
* Various bug fixes and optimizations
47+
* See [commit change]() or See [release history]()
48+
* 0.1
49+
* Initial Release
50+
51+
## License
52+
53+
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
54+
55+
## Acknowledgments
56+
57+
Inspiration, code snippets, etc.
58+
* [awesome-readme](https://github.com/matiassingers/awesome-readme)
59+
* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
60+
* [dbader](https://github.com/dbader/readme-template)
61+
* [zenorocha](https://gist.github.com/zenorocha/4526327)
62+
* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)

0 commit comments

Comments
 (0)