Skip to content

Commit 7f37c33

Browse files
authored
docs: merge duplicate Quick Start sections and streamline README (#31)
1 parent 18ac1de commit 7f37c33

File tree

1 file changed

+23
-55
lines changed

1 file changed

+23
-55
lines changed

README.md

Lines changed: 23 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,32 @@ cd git-worktree-runner
2929
sudo ln -s "$(pwd)/bin/git-gtr" /usr/local/bin/git-gtr
3030
```
3131

32-
**Use it (3 commands):**
32+
**Usage:**
3333

3434
```bash
35-
cd ~/your-repo # Navigate to git repo
36-
git gtr config set gtr.editor.default cursor # One-time setup
37-
git gtr config set gtr.ai.default claude # One-time setup
35+
# Navigate to your git repo
36+
cd ~/GitHub/my-project
37+
38+
# One-time setup (per repository)
39+
git gtr config set gtr.editor.default cursor
40+
git gtr config set gtr.ai.default claude
3841

3942
# Daily workflow
40-
git gtr new my-feature # Create worktree
41-
git gtr editor my-feature # Open in editor
42-
git gtr ai my-feature # Start AI tool
43-
git gtr rm my-feature # Remove when done
43+
git gtr new my-feature # Create worktree folder: my-feature
44+
git gtr editor my-feature # Open in cursor
45+
git gtr ai my-feature # Start claude
46+
47+
# Run commands in worktree
48+
git gtr run my-feature npm test # Run tests
49+
50+
# Navigate to worktree (alternative)
51+
cd "$(git gtr go my-feature)"
52+
53+
# List all worktrees
54+
git gtr list
55+
56+
# Remove when done
57+
git gtr rm my-feature
4458
```
4559

4660
## Why gtr?
@@ -71,58 +85,12 @@ While `git worktree` is powerful, it's verbose and manual. `git gtr` adds qualit
7185
- 🌍 **Cross-platform** - Works on macOS, Linux, and Windows (Git Bash)
7286
- 🎯 **Shell completions** - Tab completion for Bash, Zsh, and Fish
7387

74-
## Quick Start
75-
76-
```bash
77-
# Navigate to your git repo
78-
cd ~/GitHub/my-project
79-
80-
# One-time setup (per repository)
81-
git gtr config set gtr.editor.default cursor
82-
git gtr config set gtr.ai.default claude
83-
84-
# Daily workflow
85-
git gtr new my-feature # Create worktree folder: my-feature
86-
git gtr editor my-feature # Open in cursor
87-
git gtr ai my-feature # Start claude
88-
89-
# Run commands in worktree
90-
git gtr run my-feature npm test # Run tests
91-
92-
# Navigate to worktree (alternative)
93-
cd "$(git gtr go my-feature)"
94-
95-
# List all worktrees
96-
git gtr list
97-
98-
# Remove when done
99-
git gtr rm my-feature
100-
```
101-
10288
## Requirements
10389

10490
- **Git** 2.5+ (for `git worktree` support)
10591
- **Bash** 3.2+ (macOS ships 3.2; 4.0+ recommended for advanced features)
10692

107-
## Installation
108-
109-
### Quick Install (macOS/Linux)
110-
111-
```bash
112-
# Clone the repository
113-
git clone https://github.com/coderabbitai/git-worktree-runner.git
114-
cd git-worktree-runner
115-
116-
# Add to PATH (choose one)
117-
# Option 1: Symlink to /usr/local/bin
118-
sudo ln -s "$(pwd)/bin/git-gtr" /usr/local/bin/git-gtr
119-
120-
# Option 2: Add to your shell profile
121-
echo 'export PATH="$PATH:'$(pwd)'/bin"' >> ~/.zshrc # or ~/.bashrc
122-
source ~/.zshrc
123-
```
124-
125-
### Shell Completions (Optional)
93+
## Shell Completions (Optional)
12694

12795
**Bash** (requires `bash-completion` v2 and git completions):
12896

0 commit comments

Comments
 (0)