Table of Contents
[?] Provide general information about your project here. What problem does it (intend to) solve? What is the purpose of your project? Why did you undertake it? You don't have to answer all the questions -- just the ones relevant to your project.
[?] Please provide the technologies that are used in the project.
[?] What are the project requirements/dependencies?
[?] Describe how to install and get started with the project.
[?] How does one go about using it? Provide various use cases and code examples here.
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
[?] Provide additional ways to contact the project maintainer/maintainers.
Reach out to the maintainer at one of the following places:
- GitHub issues
- Contact options listed on this GitHub profile
If you want to say thank you or/and support active development of PROJECT_NAME:
- Add a GitHub Star to the project.
- Tweet about the PROJECT_NAME.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make PROJECT_NAME better!
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
The original setup of this repository is by FULL_NAME.
For a full list of all authors and contributors, see the contributors page.
PROJECT_NAME follows good practices of security, but 100% security cannot be assured. PROJECT_NAME is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the MIT license.
See LICENSE for more information.
[?] If your work was funded by any organization or institution, acknowledge their support here. In addition, if your work relies on other software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.