Skip to content

Commit d3063e6

Browse files
committed
improve readme
1 parent ce33681 commit d3063e6

File tree

1 file changed

+40
-3
lines changed

1 file changed

+40
-3
lines changed

Readme.md

+40-3
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,51 @@ G-stack is a CLI util to simplify creating stacked branches and pull requests on
1212
## Configuration
1313

1414
To be able to create and modify github prs a personal access token is needed.
15-
To specify it create a config file with the following content in `$HOME/.gstack/config.toml`
15+
Check [the official github docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
16+
and make sure the token has read/write access to pull requests.
17+
Then create a config file with the following content in `$HOME/.gstack/config.toml`
1618

1719
```toml
1820
personal_access_token = "<GITHUB_PERSONAL_ACCESS_TOKEN>"
19-
2021
```
2122

2223
## Usage
2324

2425
_Show available commands_
25-
`gs help`
26+
27+
```bash
28+
gs help
29+
```
30+
31+
_Create a new stack_
32+
33+
Creates a new stack with the current branch as a base and checks out the new branch
34+
35+
```bash
36+
gs new
37+
```
38+
39+
_Add a new stack branch_
40+
41+
Stacks a new branch on top of the current stac
42+
43+
```bash
44+
gs add
45+
```
46+
47+
_Moving through stack branches_
48+
49+
Move up and down trough stack branches with:
50+
51+
```bash
52+
gs up
53+
gs down
54+
```
55+
56+
or interactively select a stack branch with
57+
58+
```bash
59+
gs change
60+
#or
61+
gs c
62+
```

0 commit comments

Comments
 (0)