Skip to content

Commit f9c73be

Browse files
committed
docs: update installation instructions to prioritize github releases
1 parent f4ee658 commit f9c73be

3 files changed

Lines changed: 15 additions & 11 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@googleworkspace/cli": patch
3+
---
4+
5+
Update installation instructions to prioritize GitHub Releases over npm

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ Drive, Gmail, Calendar, and every Workspace API. Zero boilerplate. Structured JS
1414
</p>
1515
<br>
1616

17-
```bash
18-
npm install -g @googleworkspace/cli
19-
```
17+
⬇️ **[Download the latest release for your OS](https://github.com/googleworkspace/cli/releases)**
2018

2119
`gws` doesn't ship a static list of commands. It reads Google's own [Discovery Service](https://developers.google.com/discovery) at runtime and builds its entire command surface dynamically. When Google Workspace adds an API endpoint or method, `gws` picks it up automatically.
2220

@@ -46,15 +44,14 @@ npm install -g @googleworkspace/cli
4644

4745
## Installation
4846

47+
The recommended way to install `gws` is to download the pre-built binary for your OS and architecture from the **[GitHub Releases](https://github.com/googleworkspace/cli/releases)** page. Extract the archive and place the `gws` binary in your `$PATH`.
48+
49+
For convenience, you can also use `npm` to automate downloading the appropriate binary from GitHub Releases:
50+
4951
```bash
5052
npm install -g @googleworkspace/cli
5153
```
5254

53-
> The npm package bundles pre-built native binaries for your OS and architecture.
54-
> No Rust toolchain required.
55-
56-
Pre-built binaries are also available on the [GitHub Releases](https://github.com/googleworkspace/cli/releases) page.
57-
5855
Or build from source:
5956

6057
```bash

crates/google-workspace-cli/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
## Install
88

9+
Download the pre-built binary for your OS and architecture from the **[GitHub Releases](https://github.com/googleworkspace/cli/releases)** page.
10+
11+
Alternatively, you can use package managers as a convenience layer:
12+
913
```bash
10-
npm install -g @googleworkspace/cli # npm
14+
npm install -g @googleworkspace/cli # npm (downloads GitHub release binary)
1115
cargo install google-workspace-cli # crates.io
1216
nix run github:googleworkspace/cli # nix
1317
```
1418

15-
Pre-built binaries are available on the [GitHub Releases](https://github.com/googleworkspace/cli/releases) page.
16-
1719
## Quick Start
1820

1921
```bash

0 commit comments

Comments
 (0)