README Documentation Generator

Version: 1.0 Added: Jan 21, 2026

Description

Creates comprehensive README.md files by analyzing the project structure, package.json, and codebase. Includes installation, usage, API docs, and contribution guidelines.

Code

Skill Code

README sections:
1. Project title and description
2. Badges (build, coverage, license)
3. Features list
4. Installation instructions
5. Usage examples
6. API documentation
7. Configuration options
8. Contributing guidelines
9. License

Usage Examples

Examples

User: generate a README "keyword">for this project

Claude: *analyzes project*
```markdown
# MyApp

A modern web application "keyword">for task management.

## Features
- User authentication
- Real-time updates
- Mobile responsive

## Installation
```bash
npm install
cp .env.example .env
npm run dev
```
...
```

Installation

Add the following to your CLAUDE.md file (project root or ~/.claude/CLAUDE.md for global):

CLAUDE.md

# README Documentation Generator

README sections:
1. Project title and description
2. Badges (build, coverage, license)
3. Features list
4. Installation instructions
5. Usage examples
6. API documentation
7. Configuration options
8. Contributing guidelines
9. License

Comments (0)

No comments yet. Be the first to share your thoughts!