/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
1---2name: readme3description: README Generator4---56# /readme - README Generator78Generate or update README.md from code analysis.910## Usage11```12/readme # Generate/update README13/readme --init # Create new README from scratch14/readme --section install # Update specific section15```1617## What This Skill Does18191. **Analyze Project** - Detect type, dependencies, structure202. **Extract Info** - From pyproject.toml, Cargo.toml, etc.213. **Generate Sections** - Title, description, install, usage224. **Add Badges** - CI status, version, license235. **Write/Update** - Create or merge with existing2425## README Structure2627```markdown28# Project Name2930[](ci-url)31[](pypi-url)32[](license-url)3334Brief description of what this project does.3536## Features3738- Feature 139- Feature 240- Feature 34142## Installation4344```bash45pip install project-name46```4748## Quick Start4950```python51from project import main52main()53```5455## Usage5657### Basic Usage58...5960### Advanced Usage61...6263## Configuration6465| Option | Default | Description |66|--------|---------|-------------|67| opt1 | value | What it does |6869## Development7071```bash72git clone https://github.com/user/repo73cd repo74pip install -e ".[dev]"75pytest76```7778## Contributing7980See [CONTRIBUTING.md](CONTRIBUTING.md)8182## License8384MIT License - see [LICENSE](LICENSE)85```8687## Badge Templates8889```markdown90<!-- CI Status -->91[](https://github.com/USER/REPO/actions)9293<!-- PyPI Version -->94[](https://pypi.org/project/PACKAGE/)9596<!-- License -->97[](LICENSE)9899<!-- Python Version -->100[](https://pypi.org/project/PACKAGE/)101```102103## Instructions for Claude104105When /readme is invoked:1061071. **Detect project type** - Python, Rust, TypeScript, etc.1082. **Read config files** - pyproject.toml, Cargo.toml, package.json1093. **Extract metadata** - Name, version, description, license1104. **Analyze structure** - Main modules, entry points1115. **Check existing README** - Preserve custom content if updating1126. **Generate sections** - All standard sections1137. **Add badges** - CI, version, license1148. **Include examples** - From docstrings or tests1159. **Write file** - Create or update README.md
AreteDriver