A README is often the first item a visitor will see when visiting your repository. We recommend that your README includes information on:
What the project does
Why the project is useful
How users can get started with the project
Explain to users that there is a LEARN.md
Mention your code of conduct
Who maintains and contributes to the project
Most of the above info is already part of your Readme except a few. So please go through above list and add anything more that'll help others learn more about the project and process.
A README is often the first item a visitor will see when visiting your repository. We recommend that your README includes information on:
Most of the above info is already part of your Readme except a few. So please go through above list and add anything more that'll help others learn more about the project and process.