Skip to content

Commit a6c43cf

Browse files
committed
docs: use blob comments as git-chain README example
Assisted-by: Zed (Claude Opus 4.6)
1 parent 5bcfac9 commit a6c43cf

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

crates/git-chain/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,47 @@ Each commit's tree holds only that entry's payload — there is no accumulated s
99
### Append an event
1010

1111
```sh
12-
git chain append refs/events/log -m "build started"
12+
git chain append refs/comments/blob/a1b2c3d -m "this needs a bounds check"
1313
```
1414

1515
With a payload file:
1616

1717
```sh
18-
git chain append refs/events/log -m "test results" --payload results.json
18+
git chain append refs/comments/blob/a1b2c3d -m "suggested fix" --payload suggestion.diff
1919
```
2020

2121
With multiple payload files:
2222

2323
```sh
24-
git chain append refs/events/log -m "artifacts" --payload report.json --payload coverage.xml
24+
git chain append refs/comments/blob/a1b2c3d -m "context for the review" --payload suggestion.diff --payload trace.log
2525
```
2626

2727
### Walk a chain
2828

2929
Walk from tip to root (most recent first):
3030

3131
```sh
32-
git chain walk refs/events/log
32+
git chain walk refs/comments/blob/a1b2c3d
3333
```
3434

3535
### Threading
3636

3737
Append a reply to a specific event (second parent creates a thread):
3838

3939
```sh
40-
git chain append refs/events/log -m "follow-up" --parent <commit>
40+
git chain append refs/comments/blob/a1b2c3d -m "good catch, fixed" --parent <commit>
4141
```
4242

4343
Walk only the commits in a specific thread:
4444

4545
```sh
46-
git chain walk refs/events/log --thread <commit>
46+
git chain walk refs/comments/blob/a1b2c3d --thread <commit>
4747
```
4848

4949
### Use a different repository
5050

5151
```sh
52-
git chain -C /path/to/repo append refs/events/log -m "event"
52+
git chain -C /path/to/repo append refs/comments/blob/a1b2c3d -m "needs review"
5353
```
5454

5555
## Design

0 commit comments

Comments
 (0)