READMEs do more than explain how to use your project. They also explain why your project matters, and what your users can do with it.
In your README, try to answer the following questions:
What does this project do?
Why is this project useful?
How do I get started?
Where can I get more help, if I need it?
You can use your README to answer other questions, like how you handle contributions, what the goals of the project are, and information about licenses and attribution. If you don’t want to accept contributions, or your project is not yet ready for production, write this information down."
Ik zou ook een tekeningetje kunnen toevoegen, aan de hand van een goede uitleg. Zou ook tof zijn om een v0.1 doelstelling te hebben: wat gaat de eerste versie doen.
Bron: https://opensource.guide/starting-a-project/
"Writing a README
READMEs do more than explain how to use your project. They also explain why your project matters, and what your users can do with it.
In your README, try to answer the following questions:
What does this project do? Why is this project useful? How do I get started? Where can I get more help, if I need it? You can use your README to answer other questions, like how you handle contributions, what the goals of the project are, and information about licenses and attribution. If you don’t want to accept contributions, or your project is not yet ready for production, write this information down."