Name your project or package, because the repository name isn't enough.
put DOI badge if exists
put SWH badge
There are many services providing badges that can be helpful.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with.
Some background can always help.
A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
To help the reader install, compile and reuse your code, descrivbe the environment needed for your code.
Link to the file containing this information or directly inform your visitor of the dependencies needed.
How to use your software after it is installed. It can be helpful to explicitly write the commands and options that are possible with your code. Links to the documentation or online tutorials are a good bonus.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
This is a great bonus section, but might be harder to maintain. If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
This section can also state the authors are in a seperate file. Refer to AUTHORS and/or CONTRIBUTORS file/s.
Refer to LICENSE file or folder for further information
references: