Skip to content

Commit 37bccb5

Browse files
committed
improve README somewhat
Signed-off-by: Kipras Melnikovas <kipras@kipras.org>
1 parent 23d6820 commit 37bccb5

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ stacked diffs in git, seamlessly.
1111
</p>
1212
</div>
1313

14-
why jump through branches manually, when we can extend `git rebase -i` instead?
14+
previously, if you wanted to adopt a stacked branch workflow, you'd have to do a lot of manual work every time you'd update anything in your stack -- jump thru each branch, re-rebase it on top of the previous one, get rid of duplicate commits, resolve conflicts, try to remember what the next branch was, and repeat...
15+
16+
there must be a better way. and that's exactly how git-stacked-rebase came to be.
1517

1618
a branch is just a reference to some commit (literally, it's a single-line file that contains a 40-character commit SHA -- check your `.git/refs/` folder). why not just work on your latest feature branch, rebase comfortably, and then have your tool automatically update the partial branches to make them point to the correct new commits?
1719

@@ -25,6 +27,8 @@ it's not only a CLI either - it's first and foremost a javascript library, and t
2527

2628
in the future, we could create host-specific adapters. they could be used to automate some simple tasks, such as creating a pull request, or changing the base branch of a pull request, etc.
2729

30+
there are bigger plans as well, such as creating a browser extension to improve the experience of exploring stacked PRs.
31+
2832
## Progress
2933

3034
follow [http://kiprasmel.github.io/notes/git-stacked-rebase.html](http://kiprasmel.github.io/notes/git-stacked-rebase.html)
@@ -48,10 +52,5 @@ git config --global alias.rr git-stacked-rebase
4852
## Usage
4953

5054
```sh
51-
cd repo/
52-
53-
# checkout your remote branches locally (until we automate it w/ a command?).
54-
# then, checkout to the latest one.
55-
# then:
56-
5755
git-stacked-rebase --help
56+
```

0 commit comments

Comments
 (0)