Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bendzae committed Jul 28, 2024
1 parent d3063e6 commit ed7d240
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,15 @@ G-stack is a CLI util to simplify creating stacked branches and pull requests on

## Installation

`brew tap bendzae/gstack` and then `brew install gstack`
```bash
brew tap bendzae/gstack
```

and then

```bash
brew install gstack
```

## Configuration

Expand All @@ -22,29 +30,29 @@ personal_access_token = "<GITHUB_PERSONAL_ACCESS_TOKEN>"

## Usage

_Show available commands_
### Show available commands

```bash
gs help
```

_Create a new stack_
### Create a new stack

Creates a new stack with the current branch as a base and checks out the new branch

```bash
gs new
```

_Add a new stack branch_
### Add a new stack branch

Stacks a new branch on top of the current stac

```bash
gs add
```

_Moving through stack branches_
### Moving through stack branches

Move up and down trough stack branches with:

Expand Down

0 comments on commit ed7d240

Please sign in to comment.