Skip to content

Commit 8c43cfa

Browse files
committed
update: README.md
1 parent 5d7003b commit 8c43cfa

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919

2020
### `rsworktree create`
2121

22-
- Create a new worktree under `.rsworktree/<name>`, branching at `<name>` by default or from `--base` if provided.
22+
- Create a new worktree under `.rsworktree/<name>` using the branch name as the base.
2323
- Demo: ![Create demo](tapes/gifs/create.gif)
2424
- Options:
2525
- `--base <branch>` — branch from `<branch>` instead of `<name>`.
2626

2727
### `rsworktree cd`
2828

29-
- Spawn an interactive shell rooted in the named worktree. Use `--print` to output the path instead.
29+
- Spawn an interactive shell rooted in the named worktree.
3030
- Demo: ![CD demo](tapes/gifs/cd.gif)
3131
- Options:
3232
- `--print` — write the worktree path to stdout without spawning a shell.
@@ -40,14 +40,14 @@
4040

4141
### `rsworktree rm`
4242

43-
- Remove the named worktree. Pass `--force` to mirror `git worktree remove --force` behavior.
43+
- Remove the named worktree.
4444
- Demo: ![Remove demo](tapes/gifs/rm.gif)
4545
- Options:
4646
- `--force` — force removal, mirroring `git worktree remove --force`.
4747

4848
### `rsworktree pr-github`
4949

50-
- Push the worktree branch (unless `--no-push`) and invoke `gh pr create` with the provided options. When `<name>` is omitted, the command uses the current `.rsworktree/<name>` directory. If you don’t supply PR metadata flags, `rsworktree` automatically adds `--fill`; you can pass `--title/--body` or `--web` to override that behaviour.
50+
- Push the worktree branch and invoke `gh pr create` for the current or named worktree.
5151
- Demo: ![PR demo](tapes/gifs/pr_github.gif)
5252
- Requires the [GitHub CLI](https://cli.github.com/) (`gh`) to be installed and on your `PATH`.
5353
- Options:

0 commit comments

Comments
 (0)