/readme

From awesome-claude-agents

Description

Generate or update project README

AI Summary

Generates or updates project README files by analyzing structure and extracting key information.

Install

Add the marketplace(one-time)

/plugin marketplace add https://www.claudepluginhub.com/api/plugins/smaiil-awesome-claude-agents/marketplace.json

Install the plugin

/plugin install smaiil-awesome-claude-agents@cpd-smaiil-awesome-claude-agents

Namespace

docs/

Command Content

/readme

Generate or update the project README.md file.

Workflow

Analyze project structure:
- Check package.json, Cargo.toml, pyproject.toml, etc.
- Identify main language and framework
- Find existing documentation
Extract information:
- Project name and description
- Installation steps
- Available scripts/commands
- Dependencies
Generate README sections

README Template

# Project Name

Brief description of what this project does.

## Installation

\`\`\`bash
# Installation commands
\`\`\`

## Usage

\`\`\`bash
# Usage examples
\`\`\`

## Development

\`\`\`bash
# Development setup
\`\`\`

## Scripts

| Command | Description |
|---------|-------------|
| `npm start` | Start the app |
| `npm test` | Run tests |

## License

[License type]