readme-refresh
FeaturedAudit and update a project README, or bootstrap a new one. Detects tech stack, versions, and services.
Install
Quality Score: 91/100
Skill Content
Details
- Author
- joshukraine
- Repository
- joshukraine/dotfiles
- Created
- 12 years ago
- Last Updated
- 5 days ago
- Language
- Shell
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
readme-refresh
Use when the user asks to update, fix, or audit README.md, or when README commands look stale. Checks every command, path, and claim in the README against the actual repo and proposes a minimal diff; never rewrites the whole file unasked.
readme-sync
Audit a README against actual repo contents, identify undocumented features, and make targeted edits to bring docs in sync with what's actually installed/shipped.
readme
Create or update the repository's README — scan the codebase and document it with a title, short description, a project list, an architecture mermaid diagram with notes, an infrastructure (cloud tools) section, a local development setup guide, per-project sections (monorepo or polyrepo), and the important task-runner commands. Follows the documentation-standards skill.