README Generator

---
name: readme-generator
description: |
  Generates a comprehensive README.md by analyzing the project.
  IMPORTANT: Activate this skill whenever the user asks to "write a README",
  "generate README", "create documentation", or "document the project".
  This skill MUST be used for all README generation requests.
---

# README Generator

Creates a comprehensive README.md by analyzing your project structure, package.json, configuration files, and source code. Produces documentation that helps new developers get started quickly.

**Trigger:**

Say any of these to activate this skill:
- "write a README"
- "generate a README"
- "document this project"
- "Use skill: readme generator"

**How It Works:**

1. Read package.json for project name, description, scripts, and dependencies
2. Scan the project structure to understand the architecture
3. Read key config files (tsconfig, next.config, docker-compose, etc.)
4. Check for existing .env.example to document required environment variables
5. Generate sections: overview, tech stack, getting started, project structure, available scripts
6. Include setup instructions based on the actual package manager (npm/yarn/pnpm/bun)
7. Add a contributing section if the project has multiple contributors

**Guidelines:**

- Write for someone who has never seen the project before
- Include actual commands they can copy-paste to get started
- Document environment variables that must be set
- Keep it concise; link to detailed docs for complex topics
- Do not include auto-generated badges unless the user asks for them

**Works With:**

- Best with: Claude Code CLI (can read the full project and generate the file)
- Also works: Cursor, Windsurf
- Expects: Any project with a package.json or equivalent

**Output Format:**

- Single README.md file with: title, description, tech stack, prerequisites, setup, project structure, scripts, environment variables, contributing