I thought it would be useful to share the story behind our project's README.md, which got our GitHub repo to 4k stars in just a week.
Took all our learnings and made a guide that we hope can help your open-source project.
Love to hear your thoughts, comments or criticisms about this.