A brief introduction to your project. Include the motivation behind it and what it does.
Describe the installation process if necessary.
Provide instructions and examples for use.
Provide a visual aspect to your project. It can be a GIF or images showcasing different features.
If you want to contribute to this project, please see the Contributing Guidelines.
Describe and show how to run the tests with code examples.
Let people know the license of your project. If you don't have one, you can use https://choosealicense.com/ to choose one.
Answer some common questions about your project.
Give proper credits. Show appreciation to those who have contributed to the project.
If someone has more questions, where they can go for help. It can be any contact method you feel comfortable sharing.
If the project is ongoing, it's helpful to give updates and direction of the project.