A good description is clear, short, and to the point. Describe the importance of your project, and what it does.
Optionally, include a table of contents in order to allow other people to quickly navigate especially long or detailed READMEs.
Tell other users how to install your project locally. Optionally, include a gif to make the process even more clear for other people.
Maybe examples
Instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.
Maybe examples
Larger projects often have sections on contributing to their project, in which contribution instructions are outlined. Sometimes, this is a separate file. If you have specific contribution preferences, explain them so that other developers know how to best contribute to your work. To learn more about how to help others contribute, check out the guide for [setting guidelines for repository contributors] (https://help.github.com/articles/setting-guidelines-for-repository-contributors/).
Highlight and link to the authors of your project.
A section for the license of your project. For more information on choosing a license, check out GitHub’s [licensing guide] (http://choosealicense.com/)