Skip to content

Commit

Permalink
docs: improve the usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
wassimk committed May 17, 2024
1 parent c569299 commit d0126ed
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,36 @@
# gh-compare
## gh-compare

This is [`gh`](https://cli.github.com/) extension to replace the [`compare`](https://hub.github.com/hub-compare.1.html) command in the mostly deprecated tool, [`hub`](https://hub.github.com/).
This is a [`gh`](https://cli.github.com/) extension to replace the [`compare`](https://hub.github.com/hub-compare.1.html) command in the mostly deprecated tool, [`hub`](https://hub.github.com/).

## Installation
### Installation

```shell
gh extension install wassimk/gh-compare
```

## Usage
### Usage

Compare the current branch against the `main` branch.

```shell
gh compare
```

Compare the current branch against another branch.

```shell
gh compare other_branch
gh compare main...my-branch
```

Compare any two branches.


```shell
gh compare their_branch...my_branch
```

Compare any two commits.

```shell
gh compare 7a67154..205b073
```

0 comments on commit d0126ed

Please sign in to comment.