| name | readme |
| description | README Generator |
| lifecycle | experimental |
/readme - README Generator
Generate or update README.md from code analysis.
Usage
/readme # Generate/update README
/readme --init # Create new README from scratch
/readme --section install # Update specific section
What This Skill Does
- Analyze Project - Detect type, dependencies, structure
- Extract Info - From pyproject.toml, Cargo.toml, etc.
- Generate Sections - Title, description, install, usage
- Add Badges - CI status, version, license
- Write/Update - Create or merge with existing
README Structure
# Project Name
[](ci-url)
[](pypi-url)
[](license-url)
Brief description of what this project does.
## Features
- Feature 1
- Feature 2
- Feature 3
## Installation
```bash
pip install project-name
Quick Start
from project import main
main()
Usage
Basic Usage
...
Advanced Usage
...
Configuration
| Option | Default | Description |
|---|
| opt1 | value | What it does |
Development
git clone https://github.com/user/repo
cd repo
pip install -e ".[dev]"
pytest
Contributing
See CONTRIBUTING.md
License
MIT License - see LICENSE
## Badge Templates
```markdown
<!-- CI Status -->
[](https://github.com/USER/REPO/actions)
<!-- PyPI Version -->
[](https://pypi.org/project/PACKAGE/)
<!-- License -->
[](LICENSE)
<!-- Python Version -->
[](https://pypi.org/project/PACKAGE/)
Instructions for Claude
When /readme is invoked:
- Detect project type - Python, Rust, TypeScript, etc.
- Read config files - pyproject.toml, Cargo.toml, package.json
- Extract metadata - Name, version, description, license
- Analyze structure - Main modules, entry points
- Check existing README - Preserve custom content if updating
- Generate sections - All standard sections
- Add badges - CI, version, license
- Include examples - From docstrings or tests
- Write file - Create or update README.md