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.
Blog
Guides for writing better GitHub documentation and READMEs.
README Template for GitHub Projects — Copy, Paste, Ship
A battle-tested README template you can copy right now. Covers every section your project needs.
GitHub README Badges — The Complete Guide to Shields.io
Build status, npm version, licence, coverage — how to add professional badges to your README.
README-Driven Development — Write the Docs First, Code Second
Why writing your README before your code leads to better APIs, clearer scope, and faster shipping.