Project Title
One Paragraph of project description goes here
Note: Click the Raw button above to see the markdown source for this file and
use it yourself.
Summary
- Summary
- Getting Started
- Prerequisites
- Installing
- Usage
- Support
- Deployment
- Running the tests
- Built With
- Contributing
- Versioning
- Maintainers
- Acknowledgments
Getting Started
These instructions will get you a copy of the project up and running on your local machine. 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:
- List the
- prerequisites here
$ give examples how to install prerequisites
Installing
A step by step that tell you how to install this software
Say what the step will be
$ give example commands to accomplish the step
And repeat
$ until finished
End with an example of getting some data out of the system or using it for a little demo
Usage
How to use your software
$ cli examples go here
with some example output from the command here
Support
Please read SUPPORT.md for details on how to get support for this project.
Deployment
(optional) Add additional notes about how to deploy this on a live or production system
Running the tests
(optional) Explain how to run the automated tests for this system
You can get more detailed about how to run tests or what coding style you use in a CONTRIBUTING.md file.
Built With
Add any major libraries or frameworks
Contributing
We value your contributions! Please read CONTRIBUTING.md for details on how to contribute, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning and conventional commits for the commit format to generate release notes.
Maintainers
- Brian Torres-Gil - btorresgil
Thank you to all the contributors who participated in this project.
Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
- For example, this README template was inspired by PurpleBooth's good readme template.