运行时依赖
无特殊依赖
安装命令
点击复制官方npx clawhub@latest install readme-sync
镜像加速npx clawhub@latest install readme-sync --registry https://cn.longxiaskill.com
技能文档
name: README Sync description: Automatically read and update README.md files to maintain project documentation version: 1.0.0 author: Claude
Overview
README Sync is a skill that helps maintain up-to-date project documentation by automatically reading README.md files when needed and updating them after code operations.
Features
- Auto-read: Automatically reads README.md before code queries or modifications
- Smart update: Updates README after work completion when needed
- Trigger detection: Detects when user asks project-related questions or needs code operations
- Confirmation required: Requires confirmation before writing to README or modifying code
- Cross-platform: Works with Claude Code, OpenClaw, Trae, and other Claude CLI tools
Usage
The skill activates automatically when:
- User asks project-related questions (e.g., "what's the concurrency limit?")
- User needs to query or modify code
Read Operations
- Automatically triggered before relevant operations
- No confirmation required
- Reads project README to understand current state
Write Operations
- Triggered after work completion
- Requires explicit user confirmation before updating
- Ensures documentation stays accurate
Configuration
No special configuration required. The skill works out of the box with standard Claude CLI environments.
Security
- Read operations: Automatic, no confirmation needed
- Write operations: Require user confirmation before execution
- File access: Limited to README.md and project documentation files