Skip to content

Commit d29f41e

Browse files
Justin Poehneltgoogle-labs-jules[bot]jpoehneltgemini-code-assist[bot]
authored
fix(docs): improve README typography and spacing (npm#14)
* fix(docs): improve README typography and spacing - Remove center alignment for tagline and badges to match left-aligned body - Add `<br>` after badges for visual separation before install block - Increase whitespace above install block to emphasize it - Add an empty line above `> [!IMPORTANT]` block to decouple it from previous paragraph Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com> * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * docs: improve README typography and layout - Remove center alignment from tagline and badges - Add space below badges - Adjust spacing around install code block (remove borders, add empty line above) - Add empty line above IMPORTANT callout Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com> * docs: refine copy after install code block - Change "When Google adds an API endpoint" to "When Google Workspace adds an API endpoint or method" to be more accurate. Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com> * docs: remove horizontal borders from README Per user request, removed all remaining Markdown horizontal rules (`---`) throughout `README.md` to create a cleaner, borderless design. All previous typography and spacing improvements remain intact. Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com> --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent d93a621 commit d29f41e

2 files changed

Lines changed: 10 additions & 15 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+
Fix README typography and spacing

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,24 @@
44

55
<h1 align="center">gws</h1>
66

7-
<p align="center">
8-
<strong>One CLI for all of Google Workspace — built for humans and AI agents.</strong><br>
9-
Drive, Gmail, Calendar, and every Workspace API. Zero boilerplate. Structured JSON output. 40+ agent skills included.
10-
</p>
7+
**One CLI for all of Google Workspace — built for humans and AI agents.**<br>
8+
Drive, Gmail, Calendar, and every Workspace API. Zero boilerplate. Structured JSON output. 40+ agent skills included.
119

12-
<p align="center">
10+
<p>
1311
<a href="https://www.npmjs.com/package/@googleworkspace/cli"><img src="https://img.shields.io/npm/v/@googleworkspace/cli" alt="npm version"></a>
1412
<a href="https://github.com/googleworkspace/cli/blob/main/LICENSE"><img src="https://img.shields.io/github/license/googleworkspace/cli" alt="license"></a>
1513
<a href="https://github.com/googleworkspace/cli/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/googleworkspace/cli/ci.yml?branch=main&label=CI" alt="CI status"></a>
1614
<a href="https://www.npmjs.com/package/@googleworkspace/cli"><img src="https://img.shields.io/npm/unpacked-size/@googleworkspace/cli" alt="install size"></a>
1715
</p>
16+
<br>
1817

19-
---
2018

2119
```bash
2220
npm install -g @googleworkspace/cli
2321
```
2422

25-
---
23+
`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.
2624

27-
`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 adds an API endpoint, `gws` picks it up automatically.
2825

2926
> [!IMPORTANT]
3027
> This project is under active development. Expect breaking changes as we march toward v1.0.
@@ -58,7 +55,6 @@ Or build from source:
5855
cargo install --path .
5956
```
6057

61-
---
6258

6359
## Why gws?
6460

@@ -86,7 +82,6 @@ gws schema drive.files.list
8682
gws drive files list --params '{"pageSize": 100}' --page-all | jq -r '.files[].name'
8783
```
8884

89-
---
9085

9186
## Authentication
9287

@@ -150,7 +145,6 @@ export GOOGLE_WORKSPACE_CLI_TOKEN=$(gcloud auth print-access-token)
150145

151146
Environment variables can also live in a `.env` file.
152147

153-
---
154148

155149
## AI Agent Skills
156150

@@ -180,7 +174,6 @@ The `gws-shared` skill includes an `install` block so OpenClaw auto-installs the
180174

181175
</details>
182176

183-
---
184177

185178
## Advanced Usage
186179

@@ -212,7 +205,6 @@ gws gmail users messages get --params '...' \
212205
| `GOOGLE_WORKSPACE_CLI_SANITIZE_TEMPLATE` | Default Model Armor template |
213206
| `GOOGLE_WORKSPACE_CLI_SANITIZE_MODE` | `warn` (default) or `block` |
214207

215-
---
216208

217209
## Architecture
218210

@@ -226,7 +218,6 @@ gws gmail users messages get --params '...' \
226218

227219
All output — success, errors, download metadata — is structured JSON.
228220

229-
---
230221

231222
## Development
232223

@@ -237,7 +228,6 @@ cargo test # unit tests
237228
./scripts/coverage.sh # HTML coverage report → target/llvm-cov/html/
238229
```
239230

240-
---
241231

242232
## License
243233

0 commit comments

Comments
 (0)