README Writer

A great README answers four questions in order: what is this, why should I care, how do I run it, how do I use it. Everything else is optional — include it only if a new contributor would be blocked without it.

Before Writing

Read these first — don't guess:

• package.json / pyproject.toml / requirements.txt — project name, dependencies, scripts
• docker-compose.yml — services, ports, env vars
• AGENTS.md / CLAUDE.md — existing docs to not duplicate
• Main entry point (e.g., main.py, src/index.ts) — what it actually does
• .env.example — what config is needed

Structure by Project Type