diff --git a/.changeset/document-update-instructions.md b/.changeset/document-update-instructions.md new file mode 100644 index 00000000..ddda165c --- /dev/null +++ b/.changeset/document-update-instructions.md @@ -0,0 +1,5 @@ +--- +"@googleworkspace/cli": patch +--- + +Document how to update existing gws installations. diff --git a/README.md b/README.md index 04c532d0..8e73a58b 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ Drive, Gmail, Calendar, and every Workspace API. Zero boilerplate. Structured JS - [Prerequisites](#prerequisites) - [Installation](#installation) +- [Updating](#updating) - [Quick Start](#quick-start) - [Why gws?](#why-gws) - [Authentication](#authentication) @@ -70,6 +71,25 @@ On macOS and Linux, you can also install via [Homebrew](https://brew.sh/): brew install googleworkspace-cli ``` +## Updating + +Use the same package manager or install method you used originally: + +```bash +# Homebrew +brew update && brew upgrade googleworkspace-cli + +# npm +npm update -g @googleworkspace/cli + +# Cargo +cargo install --git https://github.com/googleworkspace/cli --locked --force +``` + +If you installed a pre-built binary manually, download the latest archive from +[GitHub Releases](https://github.com/googleworkspace/cli/releases) and replace +the `gws` binary in your `$PATH`. + ## Quick Start ```bash