From 0761b07d6592ed34126248de5ff7f1480d6b254b Mon Sep 17 00:00:00 2001 From: Sean Smith Date: Thu, 18 May 2023 21:47:12 -0700 Subject: [PATCH] docs: update readme to provide information about how to upgrade --- README.md | 13 +++++++++++++ cmd/root.go | 6 +++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 92f14cb..2ee237a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/cmd/root.go b/cmd/root.go index e4225f0..dcddd6e 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -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 {