---
id: readme-accuracy
name: README Accuracy
description: Keep README.md accurate — update it whenever features, setup steps, or APIs change
category: docs
recommended: true
---

# README Accuracy

The README is the first thing contributors and users read. Keep it correct.

**Update the README when:**
- A feature is added or removed
- Setup steps, environment variables, or dependencies change
- A public API, CLI interface, or configuration format changes

**Rules:**
- Never leave outdated command examples, screenshots, or version references
- If a section is no longer relevant, remove it rather than leaving it stale
- The README does not need to be exhaustive — it needs to be correct
