# Extension README template

Explain why someone would choose this extension, then show the first useful action inside Pi.
Keep technical detail only when needed to install, configure, use, or safely evaluate it.
Paths in this example resolve from `extensions/<name>/README.md`.

```markdown
<img src="assets/banner.svg" alt="<name>" height="70">

# <name>

Describe the user's problem and the outcome this extension provides.

![Demo: describe the behavior shown](assets/demo.gif)

## Use in Pi

Show the first slash command, model selection, or example request.
For automatic behavior, say nothing needs invoking and describe when it helps.

State required external programs, authentication, activation, or settings.
Include one minimal config example when setup needs it.
Explain any important limit, privacy implication, or way to turn it off.

[Installation](../../README.md#install)

## Reference

<!-- config:start -->
<!-- config:end -->

[Changelog](./CHANGELOG.md).
```

- No scene → omit demo.
- No changelog → omit changelog link.
- Empty generated block → omit Reference heading, keep markers.
- Extra headings or existing user guides → use only when they help someone use the extension.
- Developer internals, hooks, parsed types, debugging, benchmarks, test commands, migration history → not README content.
- Verify current commands, prerequisites, settings examples against source; old README is not evidence.
- Generated config blocks are filled by `mise run //:readme-config <name>`.