From c1f3924831e0c0844e2a5c9c02321969c6d4d485 Mon Sep 17 00:00:00 2001 From: Gourab Mondal Date: Fri, 20 Feb 2026 19:11:42 +0530 Subject: [PATCH] docs: update README to showcase templates --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e189de4..28b156a 100644 --- a/README.md +++ b/README.md @@ -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. --- @@ -62,7 +62,7 @@ annotator --revert Annotator uses a layered configuration system: -**Priority Chain:** +**Priority Chain:** `.gitignore` β†’ `.annotator.jsonc` β†’ `templates` (cumulative) ### Example `.annotator.jsonc` @@ -96,10 +96,7 @@ Annotator uses a layered configuration system: } ``` -
-πŸ“‹ Configuration Details - -### Templates +## πŸ“‹ Available Templates Annotator includes built-in templates for common frameworks: @@ -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 @@ -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. ---