This article is pretty good about about the structure of README files: medium.com/@meakaakka/a-beginners-...
It also contains a template that you can reuse.
I especially like it when the contributors with avatars are listed at the bottom. It adds a great human touch.
Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment's permalink.
Hide child comments as well
Confirm
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
This article is pretty good about about the structure of README files: medium.com/@meakaakka/a-beginners-...
It also contains a template that you can reuse.
I especially like it when the contributors with avatars are listed at the bottom. It adds a great human touch.