Skip to content

Commit c5f6ef4

Browse files
authored
Update README.md
1 parent d979397 commit c5f6ef4

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,87 @@
1-
# CRUD-mysql-redis-rabbitmq-angular
1+
# Project Title
2+
3+
One Paragraph of project description goes here
4+
5+
## Getting Started
6+
7+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
8+
9+
### Prerequisites
10+
11+
What things you need to install the software and how to install them
12+
13+
```
14+
Give examples
15+
```
16+
17+
### Installing
18+
19+
A step by step series of examples that tell you how to get a development env running
20+
21+
Say what the step will be
22+
23+
```
24+
Give the example
25+
```
26+
27+
And repeat
28+
29+
```
30+
until finished
31+
```
32+
33+
End with an example of getting some data out of the system or using it for a little demo
34+
35+
## Running the tests
36+
37+
Explain how to run the automated tests for this system
38+
39+
### Break down into end to end tests
40+
41+
Explain what these tests test and why
42+
43+
```
44+
Give an example
45+
```
46+
47+
### And coding style tests
48+
49+
Explain what these tests test and why
50+
51+
```
52+
Give an example
53+
```
54+
55+
## Deployment
56+
57+
Add additional notes about how to deploy this on a live system
58+
59+
## Built With
60+
61+
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
62+
* [Maven](https://maven.apache.org/) - Dependency Management
63+
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
64+
65+
## Contributing
66+
67+
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
68+
69+
## Versioning
70+
71+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
72+
73+
## Authors
74+
75+
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
76+
77+
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
78+
79+
## License
80+
81+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
82+
83+
## Acknowledgments
84+
85+
* Hat tip to anyone whose code was used
86+
* Inspiration
87+
* etc

0 commit comments

Comments
 (0)