Project Name

Optional: Project logo/image.

One to three sentence description of project.

Optional: GIF demoing functionality of project

Optional: Longer summary/description of project. Can include reasoning for making the project

who's currently using it in production.

Getting started information. E.g. where to do for introduction, project & community information, examples, etc.

✨ Getting started

Short how-to that explains how to get up and running with project.

Quickly explain key concepts that the user should be familiar with. They should accomplish something by the end of the how-to that demonstrates the functionality of the project.

🤔 What's next?

Points the reader where to go after completing the getting started how to.

Should link to further documentation, examples, where to go for help, etc.

🛠️ Development

Surface-level development information. Quick instructions for how to develop project.

Section should inform the reader what they must do before opening a pull request. For example, inform the reader what the minimum viable requirements for what getting a pull requested viewed are. E.g.:

Before opening a pull request, ensure that all tests are passing:

make test

After providing quick instructions, link to DEVELOPMENT.md for full contributing instructions. E.g. language standards, how to report issues, etc.

🤝 Project and community

Include information about the community around the project:

Code of Conduct for project.
Where to ask questions or get help.
How to get in touch with developers and/or wider community.
Learn more about the technology used within the project.

📋 License

Inform reader what the license for the project is and where they should go to get the full license document for the project.