Skip to content

docs: update README to showcase templates #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
assignment-sets merged 1 commit into from
Feb 20, 2026
Merged

docs: update README to showcase templates #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Annotator CLI

**Annotator** is a simple CLI utility that prepends relative file paths as comments to your project files as the first line.
**Annotator** is a simple CLI utility that prepends relative file paths as comments to your project files as the first line.
It’s designed to make AI debugging easier by automatically marking file paths for better context and easier copy-pasting.

---
Expand Down Expand Up @@ -62,7 +62,7 @@ annotator --revert

Annotator uses a layered configuration system:

**Priority Chain:**
**Priority Chain:**
`.gitignore` → `.annotator.jsonc` → `templates` (cumulative)

### Example `.annotator.jsonc`
Expand Down Expand Up @@ -96,10 +96,7 @@ Annotator uses a layered configuration system:
}
```

<details>
<summary><strong>📋 Configuration Details</strong></summary>

### Templates
## 📋 Available Templates

Annotator includes built-in templates for common frameworks:

Expand All @@ -110,7 +107,7 @@ Annotator includes built-in templates for common frameworks:
- **`python3`** - Python virtual envs, caches, Jupyter notebooks
- **`prisma`** - Prisma schema and migration exclusions

Templates are applied cumulatively in order. See all templates at:
Templates are applied cumulatively in order. See all templates at:
[github.com/assignment-sets/annotator-cli/tree/main/annotator/templates](https://github.com/assignment-sets/annotator-cli)

### Comment Styles
Expand Down Expand Up @@ -229,7 +226,7 @@ Repository: [github.com/assignment-sets/annotator-cli](https://github.com/assign

## ⚠️ Disclaimer

> This software is provided **as-is**, without warranty of any kind.
> This software is provided **as-is**, without warranty of any kind.
> Use at your own risk — the author is not responsible for data loss, crashes, or security issues.

---
Expand Down