A little brief about what the project is about. It should be like a small summary format informing about the main purpose of the project.
This section is for letting the reader know why you created this project, the reason behind pursuing such a project, and why you have decided to do it.
This basically explains the current build status of the project. If there is a bug /error which needs addressing. This is done so for two different reasons The user understands that this is an issue and does not spend more time figuring if it was a mistake on their part.A developer who is familiar with the issue can suggest some solutions directly without going through the whole code.
This lets the users know that you have used a particular code style and helps them when contributing to your project so that the whole project code style stays the same. Some common code styles: standard, xo, etc.
As the saying goes, a picture is equal to a thousand words. Most people will be interested if there is a visual representation of what the project is about. It helps them understand better. A visual representation can be snapshots of the project or a video of the functioning of the project.
This is used to help the reader understand which tech or frameworks have been used to do the project. It helps the reader understand which all tech stack he has to be familiar with to understand the whole project.
This is where you write what all extra features have been done in your project. Basically, this is where you try to make your project stand out from the rest.
This is where you try to compress your project and make the reader understand what it does as simple as possible. This should help the reader understand if your code solves their issue.
If your project needs the installation of certain software or configurations to the system. Do mention it in this section as it helps a lot for the reader to use your project. The steps mentioned should be precise and explanatory. If possible, you can add links that can help them better understand how to configure/install the necessary files or software.
If your project is small, then we can add the reference docs in the readme. For larger projects, it is better to provide links to where the API reference documentation is documented.
This is the section where you mention all the different tests that can be performed with code examples
As I have mentioned before, you never know who is going to read your readme. So it is better to provide information on how to use your project. A step-by-step guide is best suited for this purpose. It is better to explain the steps as detailed as possible because it might be a beginner who is reading it.
This is where you let them know that they can contribute and help you out. A guideline on how to contribute is also helpful
Giving proper credit is most important. Mention any links/repos which helped you or inspired you to build this project. It can be a blog, another open source project, or just people who have contributed to building this project. ex, Thank you to My Great Learning Blog for providing the context of this readMe file and GitHub Docs for providing how to format a readMe file.
A short description of the license. (MIT, Apache, etc.)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent