readme-writinglisted

A README is the front door. Its first screen must answer three questions: what is this, is it for me, how do I try it. Everything after that is in order of how soon a new user needs it. The README is verified against the code, not written from memory of the code. ## Read before writing 1. The manifest (`package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`): name, version, entry points, scripts, dependencies, engines. 2. The entry point and the public surface: CLI flags (`--help` output if it runs), exported functions, routes, config schema. 3. Existing docs, `CONTRIBUTING`, `LICENSE`, CI config, examples directory, tests (they show real usage). 4. Run the quick start you intend to document. If it does not work, the README says what actually works. ## Structure ```markdown # name One sentence: what it does and for whom. (Badges on the next line, at most four: CI, version, license, one more.) Two or three sentences: the problem it solves and the one thing that distinguishes it. Optional: a screenshot or a 10-line example that shows the payoff. ## Quick start Prerequisites in one line (runtime version, accounts, keys). The minimal commands, copy-pasteable, that produce a visible result. Nothing optional here. What the user should see when it worked. ## Usage The three to five most common tasks, each: one sentence, one code block, one sentence on the result. Link to full reference docs for the rest. ## Configuration Table: option, env var or flag, default, what it