readme

# README Generation

Generate excellent README files that communicate project value clearly and help users get started quickly.

## Core Principles

Great READMEs answer three questions immediately:

1. **What is this?** - Clear, one-sentence description of purpose
2. **Why should I care?** - The problem it solves or value it provides
3. **How do I use it?** - Quick start that gets users running in under a minute

## Before Writing

Analyse the project to understand:

- **Primary audience**: Developers? End users? Both?
- **Project maturity**: Alpha/beta? Production-ready?
- **Complexity level**: Simple utility? Complex framework?
- **Key differentiators**: What makes this stand out from alternatives?

Read existing code, configuration files, and any existing documentation to extract accurate information.

## Essential Sections

### 1. Title and Description

Start with a clear, descriptive title. Follow with a one-paragraph description that explains:

- What the project does (not how it works)
- Who it's for
- Key benefits or features

```markdown
# Project Name

Brief description of what this project does and why it exists.
A sentence about the key benefit or problem it solves.
```

### 2. Visual Elements (When Applicable)

Add visual elements that communicate quickly:

- **Badges**: Build status, version, licence, coverage
- **Logo/Banner**: Professional branding for larger projects
- **Screenshot/GIF**: Show the tool in action (especially for CLIs and UIs)
- **Architecture diagram**: For complex systems

Place badges immediately after the title. Place screenshots/GIFs after the description.

### 3. Quick Start

Provide the fastest path to a working example:

```markdown
## Quick Start

\`\`\`bash
npm install project-name
\`\`\`

\`\`\`javascript
import { thing } from 'project-name';
thing.doSomething();
\`\`\`
```

Keep quick start under 5 steps. Link to detailed installation for complex setups.

### 4. Installation

Cover all supported installation methods:

- P