Skip to content

Commit

Permalink
docs: update readme to provide information about how to upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
wwsean08 committed May 19, 2023
1 parent 166cfba commit 0761b07
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ This `gh` extension can be used to monitor the current status of GitHub based on
gh extension install wwsean08/gh-gh-status
```

## Upgrade
As a note, GitHub really doesn't like your command starting with `gh` like this one does. In order to upgrade the plugin you can run one of the following commands:

```shell
gh extension upgrade wwsean08/gh-gh-status
```

or

```shell
gh extension upgrade gh-gh-status
```

## Usage
### Run once
```shell
Expand Down
6 changes: 5 additions & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ var rootCmd = &cobra.Command{
Use: "gh-status",
Short: "Check the status of github.com",
Long: `A simple command to get the current status of github.com according th githubstatus.com
with the ability to poll it every minute to keep an eye on ongoing incidents.`,
with the ability to poll it every minute to keep an eye on ongoing incidents.
To upgrade the extension run the following command:
gh extension upgrade gh-gh-status
`,
Run: func(cmd *cobra.Command, args []string) {
watch, err := cmd.Flags().GetBool("watch")
if err != nil {
Expand Down

0 comments on commit 0761b07

Please # to comment.