I'm a huge fan of writing READMEs, and I hold GitHub entirely responsible :). The need for docs varies, but everything needs an overview.
miniblog.
Related Posts
I'm hesitant to write "written in $LANG" on my project READMEs. I'd rather get users excited about the features than the implementation.
Maybe it makes sense if you're primarily seeking contributors?
GitHub READMEs work exceptionally well for projects which only need a single page of docs.
Transitioning to a hosted, multiple page documentation structure is hard though. I've dabbled with a few tools but not found a clear favourite yet.
Badges to Acknowledge Open Practices: A Simple, Low-Cost, Effective Method for Increasing Transparency https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1002456
'Open Data' badges on scientific papers hugely increased the amount of open data. Reminds me of READMEs with testing badges!