readme-reviewlisted

# README Review Skill Review a project's README (and top-level documentation) against a quality rubric, then optionally redraft weak sections. The rubric is judged against the project TYPE — a library README and a CLI README have different obligations. The central test: could a newcomer who has never seen this project install it and run it successfully from the README alone? ## Step 1: Locate the README If the user provided a file path as an argument, use that. Otherwise glob for: `README*`, `readme*`, `README.md`, `README.rst`, `README.txt` Prefer the one at the repository root. If multiple candidates exist at the same depth, use AskUserQuestion. Read the full README. Also glob for adjacent top-level docs that the README's quality depends on: `CONTRIBUTING*`, `LICENSE*`, `CHANGELOG*`, `docs/`, `INSTALL*`, `USAGE*`. Note which exist — their presence or absence feeds the checklists. ## Step 2: Infer Project Type Determine the project type from repository signals. This sets the expectations the README is judged against — load the matching profile from `~/.claude/skills/readme-review/references/README-PATTERNS.md`. Detect signals: ```bash ~/.claude/skills/readme-review/scripts/score-readme.sh <readme-file> ``` The script reports detected signals, but confirm the type yourself: - **Library / package** — `package.json` with no `bin`, `Cargo.toml` `[lib]`, `pyproject.toml` with a package, `go.mod` importable. Consumers write code against it. Expects: install, import sni