How to Write a Good README.md — The Complete Guide
Your README is the first thing people see. Here's exactly what to include, in what order, with examples from top repos.
Guides for writing better GitHub documentation and READMEs.
Your README is the first thing people see. Here's exactly what to include, in what order, with examples from top repos.
A battle-tested README template you can copy right now. Covers every section your project needs.
Build status, npm version, licence, coverage — how to add professional badges to your README.
Why writing your README before your code leads to better APIs, clearer scope, and faster shipping.