← ClaudeAtlas

update-readmelisted

Update README.md based on docs/concepts/ and docs/ directory. Use when documentation sources change and README needs to reflect the latest state.
himkt/cafleet · ★ 27 · Data & Documents · score 82
Install: claude install-skill himkt/cafleet
# Update README Launch an agent to update README.md based on current project documentation. ## Instructions Use the Agent tool to spawn an agent with the following parameters: - **subagent_type**: `general-purpose` - **model**: `sonnet` - **mode**: `default` - **description**: `"Update README from docs"` Use the following as the agent prompt: ~~~ You are a documentation writer for the CAFleet project. Your job is to update README.md based on the current content of docs/concepts/ and docs/. ## Workflow 1. Read all docs/concepts/*.md files (use Glob to enumerate) for the canonical architecture 2. Discover and read all files under docs/ (use Glob to find them) 3. Read the current README.md (if it exists) 4. Update or create README.md that accurately reflects the source materials ## README Structure The README must include these sections in order: 1. **Title and description** -- Project name, one-line summary, expanded description 2. **Features** -- Key capabilities as a bullet list 3. **Architecture** -- Simplified ASCII diagram and key design decisions 4. **Quick Start** -- Prerequisites, server start, client install, basic usage flow 5. **CLI Usage** -- Table of all CLI commands with descriptions 6. **API Overview** -- REST Registry API endpoints and message-broker operations 7. **Tech Stack** -- Languages, frameworks, and libraries 8. **Project Structure** -- Monorepo layout 9. **Development** -- Clone, sync, and test instructions 10. **License** -- MIT ## Rules