Skip to content

Commit 39cde21

Browse files
authored
Update README.md
1 parent 9014499 commit 39cde21

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

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

3-
A Go-based CLI tool that provides a one-command workflow to isolate AI-generated "memory" files onto a dedicated Git branch with worktree, automatic symlinks, and easy sync.
3+
A Go-based CLI tool that provides a one-command workflow to isolate AI-generated "memory" files (GEMINI.md, CLAUDE.md etc) onto a dedicated Git branch with worktree and easy sync.
44

55
## Features
66

7-
- Creates an orphan branch for AI memory files
7+
- Creates an orphan branch for AI memory files(GEMINI.md, CLAUDE.md, .cursor/rules/)
88
- Sets up a Git worktree for isolated file management
9-
- Creates symlinks from project root to worktree
109
- Automatically updates .gitignore
1110
- Separate pull/push commands for flexible workflow
1211
- Support for multiple AI agents (Cline, Claude, Gemini, Cursor)
@@ -68,7 +67,7 @@ This command:
6867
ai-docs push [--config path/to/config.yml] [--dry-run] [-v]
6968
```
7069

71-
Copies local AI docs to the worktree, commits and pushes changes to remote.
70+
Copies local AI docs to the worktree, commits and pushes ( to the `@ai-docs/username` branch ) changes to remote.
7271

7372
### Pull changes
7473

@@ -107,7 +106,7 @@ ignorePatterns:
107106
- "/memory-bank/"
108107
- "CLAUDE.md"
109108
- "GEMINI.md"
110-
- "/.cursor/rules/"
109+
- "/.cursor/rules"
111110
```
112111
113112
## Requirements
@@ -119,4 +118,4 @@ ignorePatterns:
119118
120119
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
121120
122-
Copyright 2025 Teruo Kunihiro
121+
Copyright 2025 Teruo Kunihiro

0 commit comments

Comments
 (0)