# Config Directory README Template
Use this template for XDG config directories, dotfiles, script folders,
and any local directory you'll return to later wondering "what is this?"
The audience is future-you, probably confused.
---
# [Tool/Directory Name] Config
> Last reviewed: [YYYY-MM-DD]
[One sentence: what this directory configures and why you have custom config]
## What's Here
| Path | Purpose |
|------|---------|
| `[file-or-dir]` | [What it does] |
| `[file-or-dir]` | [What it does] |
| `[file-or-dir]` | [What it does] |
### [Subdirectory 1] (if complex enough to warrant detail)
[Brief explanation of what's in this subdirectory]
### [Subdirectory 2]
[Brief explanation]
## Why This Setup
[1-2 paragraphs explaining your philosophy or goals for this config. What problems were you solving? What workflow are you optimizing for?]
## How to Extend
### Adding a new [thing]
1. [Step 1]
2. [Step 2]
3. [Step 3]
### Adding a new [other thing]
1. [Steps]
## Dependencies
[What needs to be installed for this config to work]
```bash
[Install commands if applicable]
```
## Gotchas
- [Thing that will confuse future-you]
- [Non-obvious behavior]
- [Files that shouldn't be edited directly]
- [Order dependencies or load sequences]
## Sync/Backup
[How this config is backed up or synced across machines, if applicable]
## Related
- [Link to tool's official docs]
- [Link to your dotfiles repo if this is part of it]
- [Other relevant resources]
Source: claude-code-templates (MIT). See About Us for full credits.