WHEN: README generation/update, project documentation, installation/usage/contribution guides WHAT: Project analysis + sectioned README templates + badges + environment variable docs WHEN NOT: API docs → api-documenter, Code comments → api-documenter
Analyzes your project structure to generate comprehensive README.md files with installation instructions, usage examples, badges, and environment variable documentation. Use it when creating new projects or updating existing documentation.
/plugin marketplace add physics91/claude-vibe/plugin install claude-vibe@physics91-pluginsThis skill inherits all available tools. When active, it can use any tool Claude has access to.
Analyzes project structure to generate or update README.md with installation, usage, API docs, and more.
**Project**: my-awesome-app
**Type**: Next.js Web Application
**Language**: TypeScript
**Package Manager**: npm
**Dependencies**: React, Next.js, Tailwind CSS
**Scripts**: dev, build, start, test, lint
README Status:
- Exists: [Yes/No]
- Current sections: [list]
- Last modified: [date]
AskUserQuestion:
"Select README sections"
Options:
- Project intro/overview
- Installation
- Usage/Getting started
- Environment variables
- API documentation
- Contributing guide
- License
multiSelect: true
AskUserQuestion:
"Select README style"
Options:
- Concise (essentials only)
- Detailed (screenshots/GIFs)
- Technical (API-focused)
- Open source (badges, contributing)
# Project Name
Brief description (1-2 sentences)
## Features
- Feature 1
- Feature 2
## Installation
\`\`\`bash
git clone https://github.com/username/project.git
cd project
npm install
\`\`\`
## Usage
\`\`\`bash
npm run dev # Development
npm run build # Production build
\`\`\`
## Environment Variables
Create `.env.local`:
\`\`\`env
DATABASE_URL=your_database_url
NEXT_PUBLIC_API_URL=your_api_url
\`\`\`
| Variable | Required | Description |
|----------|----------|-------------|
| `DATABASE_URL` | Yes | Database connection string |
## Tech Stack
- **Framework**: Next.js 14
- **Language**: TypeScript
## Project Structure
\`\`\`
├── app/ # Next.js App Router
├── components/ # React components
├── lib/ # Utilities
└── public/ # Static assets
\`\`\`
## Contributing
1. Fork the repository
2. Create feature branch
3. Commit changes
4. Push to branch
5. Open Pull Request
## License
MIT License
# Project Name
[](https://www.npmjs.com/package/package)
[](https://github.com/user/repo/actions)
[](https://codecov.io/gh/user/repo)
> Compelling project description
## Installation
\`\`\`bash
npm install package-name
\`\`\`
## Usage
\`\`\`typescript
import { feature } from 'package-name'
const result = feature({ option: 'value' })
\`\`\`
## API Reference
### `feature(options)`
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `option` | `string` | `'default'` | Description |
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
MIT - see [LICENSE](LICENSE)
## README Generated
**File**: README.md
**Style**: Detailed
### Included Sections
- [x] Project intro
- [x] Installation
- [x] Usage
- [x] Environment variables
- [x] Tech stack
- [x] Contributing
- [x] License
### Recommendations
- [ ] Add screenshots/demo GIF
- [ ] Detail API documentation
- [ ] Create CONTRIBUTING.md
api-documenter skill: API section details/explain-code command: Project structure understandingThis skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.
This skill should be used when the user asks to "create an agent", "add an agent", "write a subagent", "agent frontmatter", "when to use description", "agent examples", "agent tools", "agent colors", "autonomous agent", or needs guidance on agent structure, system prompts, triggering conditions, or agent development best practices for Claude Code plugins.
This skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", "use ${CLAUDE_PLUGIN_ROOT}", "set up event-driven automation", "block dangerous commands", or mentions hook events (PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification). Provides comprehensive guidance for creating and implementing Claude Code plugin hooks with focus on advanced prompt-based hooks API.