...
- Purpose of the project so that users can understand what the project is about, enhancing user experience.
- Describe how to use the project, the mechanism, and the functionalities of various features. Make the reader understand the technology, before using it. Gives instructions on how to do the specific task. It consists of steps that need to be followed.
- Provide relevant links, code snippets, and algorithms.
- Provide images, graphics, tables, flow charts, user flow, etc.
- Feedback from users
- Conclusion and people to contact for more information (maintainers, project mentor)
Resources:
https://github.com/devspace/awesome-github-templates
Best Practices Badges / Templates
...