# <collection-name>

One sentence: what this collection does and why it exists.

## Prerequisites

- Where it runs: `odin` (Unraid) / this workstation / either
- Interpreters: bash / Python 3 / Node 22
- External tools: e.g. `docker`, `tea`, `curl`
- Access needed: e.g. SSH to odin, Gitea API token

## Configuration

Copy `.env.example` to `.env` and fill it in. Real values live in `<where>`.

| Variable | Required | Description |
| --- | --- | --- |
| `EXAMPLE_HOST` | yes | Target host to operate against |

## Usage

```bash
bin/example --dry-run          # preview, changes nothing
bin/example                    # apply
```

## Behaviour notes

- Idempotent: yes/no — and what happens on a re-run.
- Destructive operations: list them, or state "none".
- Scheduling: cron entry / Unraid User Scripts / manual only.

## Gotchas

Anything that cost time to discover. This is the section that earns the collection its
own folder — keep it honest and current.