update-readme
更新 README.md 以匹配当前项目状态。当用户说“更新自述文件”、“同步自述文件”、“刷新文档”、“自述文件已过时”或要求记录项目时使用。
📖 中文导读:更新 README.md 以匹配当前项目状态。当用户说“更新自述文件”、“同步自述文件”、“刷新文档”、“自述文件已过时”或要求记录项目时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: update-readme description: Updates README.md to match the current project state. Use when the user says "update readme", "sync readme", "refresh documentation", "readme is outdated", or asks to document the project. allowed-tools: Read, Glob, Grep, Edit, Write
Update README
Analyze a project's codebase and update its README.md to accurately reflect the current state.
Instructions
- Read the current
README.mdto understand existing structure - Read package files (
package.json,Cargo.toml,pyproject.toml,go.mod, etc.) for metadata - Use Glob to understand directory layout (
**/*.{js,ts,py,go,rs}) - Compare README against actual codebase for discrepancies
- Update only sections that are outdated or incorrect
- Provide a summary of changes made
What to verify
- Dependencies: Match actual package files
- Features: Reflect capabilities found in code
- Installation: Steps work with current setup
- Usage examples: Code snippets are accurate
- File references: Mentioned paths exist
- Configuration: Options are complete
Rules
- MUST preserve existing README structure when possible
- MUST keep any badges, images, or custom formatting
- MUST use relative links for internal documentation
- Never add sections that weren't requested
- Never remove sections without explicit approval
- Never fabricate features not found in the codebase
Output
After updating, summarize:
- Sections updated
- What was added or removed
- Anything needing manual review