-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve the usage instructions
- Loading branch information
Showing
1 changed file
with
23 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |