Give people an idea about what the project accomplishes and the problems that it solves.
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section.
If there area prerequisites, provide instructions on how to install them here.
Provide instructions on how to install this project.
Show useful examples of a basic getting up and running.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
Take a look at our contribution guide for more details.
$PROJECT_NAME takes security very seriously. Please take a moment to review our security documentation which includes details of how to disclose a vulnerability responsibly.