# {{PROJECT_NAME}}

> {{ONE_LINE_DESCRIPTION_FROM_PACKAGE_JSON}}

## What is this?

{{2-3 SENTENCES: THE PROBLEM THIS PROJECT SOLVES AND HOW IT SOLVES IT.}}

## Quick Start

```bash
# Install
{{PACKAGE_MANAGER}} install {{PACKAGE_NAME}}

# Minimal usage example
{{USAGE_EXAMPLE}}
```

## Features

- **{{FEATURE_1}}** — {{BRIEF_DESCRIPTION}}
- **{{FEATURE_2}}** — {{BRIEF_DESCRIPTION}}
- **{{FEATURE_3}}** — {{BRIEF_DESCRIPTION}}

## Architecture

> Include this section if the project has 5+ source directories.

```
{{PROJECT_NAME}}/
├── {{DIR_1}}/      # {{RESPONSIBILITY_1}}
├── {{DIR_2}}/      # {{RESPONSIBILITY_2}}
└── {{DIR_3}}/      # {{RESPONSIBILITY_3}}
```

## Configuration

| File | Purpose |
|------|---------|
| `{{CONFIG_FILE_1}}` | {{PURPOSE}} |
| `{{CONFIG_FILE_2}}` | {{PURPOSE}} |

**Key environment variables:**

| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `{{ENV_VAR_1}}` | Yes / No | `{{DEFAULT}}` | {{DESCRIPTION}} |

## Development

```bash
# Install dependencies
{{INSTALL_COMMAND}}

# Build
{{BUILD_COMMAND}}

# Test
{{TEST_COMMAND}}

# Lint
{{LINT_COMMAND}}
```

## API Reference

> Include if the project exposes a public API.

### `{{FUNCTION_OR_CLASS_NAME}}`

```typescript
{{FUNCTION_SIGNATURE}}
```

{{DESCRIPTION}}

**Parameters:**
- `{{PARAM_1}}` — {{TYPE}}: {{DESCRIPTION}}

**Returns:** `{{RETURN_TYPE}}` — {{DESCRIPTION}}

## License

{{LICENSE}} — see [LICENSE](./LICENSE)
