I wrote a blog post about writing a README for your Open Source project

https://dev.to/github/how-to-create-the-perfect-readme-for-your-open-source-project-1k69