mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-11-13 03:35:52 +01:00
82 lines
1.6 KiB
Markdown
82 lines
1.6 KiB
Markdown
|
# Project Title
|
||
|
|
|
||
|
|
One Paragraph of project description goes here
|
||
|
|
|
||
|
|
## 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 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
|
||
|
|
|
||
|
|
```
|
||
|
|
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
|
||
|
|
|
||
|
|
```
|
||
|
|
Give the example
|
||
|
|
```
|
||
|
|
|
||
|
|
And repeat
|
||
|
|
|
||
|
|
```
|
||
|
|
until finished
|
||
|
|
```
|
||
|
|
|
||
|
|
End with an example of getting some data out of the system or using it for a little demo
|
||
|
|
|
||
|
|
## Running the tests
|
||
|
|
|
||
|
|
Explain how to run the automated tests for this system
|
||
|
|
|
||
|
|
### Break down into end to end tests
|
||
|
|
|
||
|
|
Explain what these tests test and why
|
||
|
|
|
||
|
|
```
|
||
|
|
Give an example
|
||
|
|
```
|
||
|
|
|
||
|
|
### And coding style tests
|
||
|
|
|
||
|
|
Explain what these tests test and why
|
||
|
|
|
||
|
|
```
|
||
|
|
Give an example
|
||
|
|
```
|
||
|
|
|
||
|
|
## Deployment
|
||
|
|
|
||
|
|
Add additional notes about how to deploy this on a live system
|
||
|
|
|
||
|
|
## Built With
|
||
|
|
|
||
|
|
* The web framework used
|
||
|
|
* Dependency Management
|
||
|
|
* Used to generate RSS Feeds
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|
||
|
|
|
||
|
|
## Acknowledgments
|
||
|
|
|
||
|
|
* Hat tip to anyone whose code was used
|
||
|
|
* Inspiration
|
||
|
|
* etc
|