Skip to content

Commit a91fa61

Browse files
docs: update README to showcase templates (#3)
1 parent d3068b1 commit a91fa61

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Annotator CLI
22

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

66
---
@@ -62,7 +62,7 @@ annotator --revert
6262

6363
Annotator uses a layered configuration system:
6464

65-
**Priority Chain:**
65+
**Priority Chain:**
6666
`.gitignore``.annotator.jsonc``templates` (cumulative)
6767

6868
### Example `.annotator.jsonc`
@@ -96,10 +96,7 @@ Annotator uses a layered configuration system:
9696
}
9797
```
9898

99-
<details>
100-
<summary><strong>📋 Configuration Details</strong></summary>
101-
102-
### Templates
99+
## 📋 Available Templates
103100

104101
Annotator includes built-in templates for common frameworks:
105102

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

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

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

230227
## ⚠️ Disclaimer
231228

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

0 commit comments

Comments
 (0)