What problem does it solve? Project READMEs drift out of sync with the actual codebase — stale versions, removed endpoints, wrong commands, and undocumented features mislead contributors and users. This Skill rewrites or updates a README using only facts verified from real source files, never invented content. ## Core Features & Use Cases - Evidence-based generation: Scans manifests (package.json, go.mod, pyproject.toml), entry points, routes, env vars, scripts, migrations, and CI workflows so every claim traces to a file that was read. - Gap analysis against existing README: Compares the current README to the codebase, preserving valid sections and rewriting only what is stale. - Audience-aware templates: Ships reference templates for open source, personal, internal/team, and config-directory READMEs, plus a style guide of common mistakes. - Use Case: After shipping a new API version, run the Skill to detect outdated endpoints and env vars in your README and produce an updated document with a summary of what changed. ## Quick Start Ask the agent to regenerate or update the project README from the current codebase, optionally scoping it to specific sections or a target file other than README.md.
