A template for your project README.
Describe what does this project does in one line followed by your project logo if you have one. e.g., who might be interested in it, what language its written in, and how it might be different from similar projects.
- Include a list of features and limitations.
- States the goals and scope of the project to help set expectations and filter proposed changes down the line.
- Include the current status (e.g., proof of concept, used in production, active development, orphaned, etc.)
- Include link to demo or production instance
It includes a high-level development roadmap or link to open issues/milestones. It explicitly asks for contributions, if you want them, with a link to CONTRIBUTING.md.
It includes a description of the kind of environment required to run the software and instructions for setting it up. It clearly states the external dependencies and directions for installing them.
Be sure to follow the <COMPANY_NAME> logo guidelines.
This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.
XXX: Enter at least one maintainer in here or point to codeowners file.
XXX: Be explicit about support expectations.