So you finished writing your amazing opensource project, you are ready to publish it and make it public … But something stops you. If you are like me, then the infamous README.md is the last file you author.

Whenever I start a project README.md is one of the reason, if not the only reason, that makes me dubious about the project.

What to write here? How much is enough? Should I put this here? Should it go to another file? Authors? Change log? These are some questions the pop into my head in each project.

If you also have these questions, then read on, this article might be just for you.

Readme has multiple definitions, the best description I found is from Jargon file: