From 7486fd0c27c2dc7be5d9af0773a0a564161249ef Mon Sep 17 00:00:00 2001 From: Rhuan Barreto Date: Sun, 31 May 2026 00:47:00 +0200 Subject: [PATCH] docs: simplify README installation and quick start sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace verbose installation commands with a single line linking to the installation guide — the README now serves many package managers and duplicating all options was unwieldy. Remove the install step from Quick Start since users arrive there after installing. Signed-off-by: Rhuan Barreto --- README.md | 49 +++-------------------------- shims/go/README.md | 49 +++-------------------------- shims/maven/README.md | 49 +++-------------------------- shims/nuget/Archgate.Tool/README.md | 49 +++-------------------------- shims/pypi/README.md | 49 +++-------------------------- shims/rubygem/README.md | 49 +++-------------------------- 6 files changed, 30 insertions(+), 264 deletions(-) diff --git a/README.md b/README.md index bf7af08e..2ae22f88 100644 --- a/README.md +++ b/README.md @@ -39,61 +39,22 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR ## Installation -**Standalone** (no Node.js required): - -```bash -# macOS / Linux -curl -fsSL https://cli.archgate.dev/install-unix | sh - -# Windows (PowerShell) -irm https://cli.archgate.dev/install-windows | iex - -# Windows (Git Bash / MSYS2) -curl -fsSL https://cli.archgate.dev/install-unix | sh -``` - -**Via npm** (or any Node.js package manager): - -```bash -# npm -npm install -g archgate - -# Bun -bun install -g archgate - -# Yarn -yarn global add archgate - -# pnpm -pnpm add -g archgate -``` - -You can also install as a dev dependency: - -```bash -npm install -D archgate # or: bun add -d archgate -npx archgate check # run via package manager -``` - -**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options. +Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the **[installation guide](https://cli.archgate.dev/getting-started/installation/)** for all options and platform support. ## Quick start ```bash -# 1. Install -curl -fsSL https://cli.archgate.dev/install-unix | sh # or: npm install -g archgate - -# 2. Initialize governance in your project +# 1. Initialize governance in your project cd my-project archgate init -# 3. Edit the generated ADR to document a real decision +# 2. Edit the generated ADR to document a real decision # .archgate/adrs/ARCH-001-*.md -# 4. Add a companion .rules.ts to enforce it automatically +# 3. Add a companion .rules.ts to enforce it automatically # .archgate/adrs/ARCH-001-*.rules.ts -# 5. Run checks +# 4. Run checks archgate check ``` diff --git a/shims/go/README.md b/shims/go/README.md index bf7af08e..2ae22f88 100644 --- a/shims/go/README.md +++ b/shims/go/README.md @@ -39,61 +39,22 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR ## Installation -**Standalone** (no Node.js required): - -```bash -# macOS / Linux -curl -fsSL https://cli.archgate.dev/install-unix | sh - -# Windows (PowerShell) -irm https://cli.archgate.dev/install-windows | iex - -# Windows (Git Bash / MSYS2) -curl -fsSL https://cli.archgate.dev/install-unix | sh -``` - -**Via npm** (or any Node.js package manager): - -```bash -# npm -npm install -g archgate - -# Bun -bun install -g archgate - -# Yarn -yarn global add archgate - -# pnpm -pnpm add -g archgate -``` - -You can also install as a dev dependency: - -```bash -npm install -D archgate # or: bun add -d archgate -npx archgate check # run via package manager -``` - -**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options. +Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the **[installation guide](https://cli.archgate.dev/getting-started/installation/)** for all options and platform support. ## Quick start ```bash -# 1. Install -curl -fsSL https://cli.archgate.dev/install-unix | sh # or: npm install -g archgate - -# 2. Initialize governance in your project +# 1. Initialize governance in your project cd my-project archgate init -# 3. Edit the generated ADR to document a real decision +# 2. Edit the generated ADR to document a real decision # .archgate/adrs/ARCH-001-*.md -# 4. Add a companion .rules.ts to enforce it automatically +# 3. Add a companion .rules.ts to enforce it automatically # .archgate/adrs/ARCH-001-*.rules.ts -# 5. Run checks +# 4. Run checks archgate check ``` diff --git a/shims/maven/README.md b/shims/maven/README.md index bf7af08e..2ae22f88 100644 --- a/shims/maven/README.md +++ b/shims/maven/README.md @@ -39,61 +39,22 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR ## Installation -**Standalone** (no Node.js required): - -```bash -# macOS / Linux -curl -fsSL https://cli.archgate.dev/install-unix | sh - -# Windows (PowerShell) -irm https://cli.archgate.dev/install-windows | iex - -# Windows (Git Bash / MSYS2) -curl -fsSL https://cli.archgate.dev/install-unix | sh -``` - -**Via npm** (or any Node.js package manager): - -```bash -# npm -npm install -g archgate - -# Bun -bun install -g archgate - -# Yarn -yarn global add archgate - -# pnpm -pnpm add -g archgate -``` - -You can also install as a dev dependency: - -```bash -npm install -D archgate # or: bun add -d archgate -npx archgate check # run via package manager -``` - -**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options. +Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the **[installation guide](https://cli.archgate.dev/getting-started/installation/)** for all options and platform support. ## Quick start ```bash -# 1. Install -curl -fsSL https://cli.archgate.dev/install-unix | sh # or: npm install -g archgate - -# 2. Initialize governance in your project +# 1. Initialize governance in your project cd my-project archgate init -# 3. Edit the generated ADR to document a real decision +# 2. Edit the generated ADR to document a real decision # .archgate/adrs/ARCH-001-*.md -# 4. Add a companion .rules.ts to enforce it automatically +# 3. Add a companion .rules.ts to enforce it automatically # .archgate/adrs/ARCH-001-*.rules.ts -# 5. Run checks +# 4. Run checks archgate check ``` diff --git a/shims/nuget/Archgate.Tool/README.md b/shims/nuget/Archgate.Tool/README.md index bf7af08e..2ae22f88 100644 --- a/shims/nuget/Archgate.Tool/README.md +++ b/shims/nuget/Archgate.Tool/README.md @@ -39,61 +39,22 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR ## Installation -**Standalone** (no Node.js required): - -```bash -# macOS / Linux -curl -fsSL https://cli.archgate.dev/install-unix | sh - -# Windows (PowerShell) -irm https://cli.archgate.dev/install-windows | iex - -# Windows (Git Bash / MSYS2) -curl -fsSL https://cli.archgate.dev/install-unix | sh -``` - -**Via npm** (or any Node.js package manager): - -```bash -# npm -npm install -g archgate - -# Bun -bun install -g archgate - -# Yarn -yarn global add archgate - -# pnpm -pnpm add -g archgate -``` - -You can also install as a dev dependency: - -```bash -npm install -D archgate # or: bun add -d archgate -npx archgate check # run via package manager -``` - -**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options. +Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the **[installation guide](https://cli.archgate.dev/getting-started/installation/)** for all options and platform support. ## Quick start ```bash -# 1. Install -curl -fsSL https://cli.archgate.dev/install-unix | sh # or: npm install -g archgate - -# 2. Initialize governance in your project +# 1. Initialize governance in your project cd my-project archgate init -# 3. Edit the generated ADR to document a real decision +# 2. Edit the generated ADR to document a real decision # .archgate/adrs/ARCH-001-*.md -# 4. Add a companion .rules.ts to enforce it automatically +# 3. Add a companion .rules.ts to enforce it automatically # .archgate/adrs/ARCH-001-*.rules.ts -# 5. Run checks +# 4. Run checks archgate check ``` diff --git a/shims/pypi/README.md b/shims/pypi/README.md index bf7af08e..2ae22f88 100644 --- a/shims/pypi/README.md +++ b/shims/pypi/README.md @@ -39,61 +39,22 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR ## Installation -**Standalone** (no Node.js required): - -```bash -# macOS / Linux -curl -fsSL https://cli.archgate.dev/install-unix | sh - -# Windows (PowerShell) -irm https://cli.archgate.dev/install-windows | iex - -# Windows (Git Bash / MSYS2) -curl -fsSL https://cli.archgate.dev/install-unix | sh -``` - -**Via npm** (or any Node.js package manager): - -```bash -# npm -npm install -g archgate - -# Bun -bun install -g archgate - -# Yarn -yarn global add archgate - -# pnpm -pnpm add -g archgate -``` - -You can also install as a dev dependency: - -```bash -npm install -D archgate # or: bun add -d archgate -npx archgate check # run via package manager -``` - -**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options. +Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the **[installation guide](https://cli.archgate.dev/getting-started/installation/)** for all options and platform support. ## Quick start ```bash -# 1. Install -curl -fsSL https://cli.archgate.dev/install-unix | sh # or: npm install -g archgate - -# 2. Initialize governance in your project +# 1. Initialize governance in your project cd my-project archgate init -# 3. Edit the generated ADR to document a real decision +# 2. Edit the generated ADR to document a real decision # .archgate/adrs/ARCH-001-*.md -# 4. Add a companion .rules.ts to enforce it automatically +# 3. Add a companion .rules.ts to enforce it automatically # .archgate/adrs/ARCH-001-*.rules.ts -# 5. Run checks +# 4. Run checks archgate check ``` diff --git a/shims/rubygem/README.md b/shims/rubygem/README.md index bf7af08e..2ae22f88 100644 --- a/shims/rubygem/README.md +++ b/shims/rubygem/README.md @@ -39,61 +39,22 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR ## Installation -**Standalone** (no Node.js required): - -```bash -# macOS / Linux -curl -fsSL https://cli.archgate.dev/install-unix | sh - -# Windows (PowerShell) -irm https://cli.archgate.dev/install-windows | iex - -# Windows (Git Bash / MSYS2) -curl -fsSL https://cli.archgate.dev/install-unix | sh -``` - -**Via npm** (or any Node.js package manager): - -```bash -# npm -npm install -g archgate - -# Bun -bun install -g archgate - -# Yarn -yarn global add archgate - -# pnpm -pnpm add -g archgate -``` - -You can also install as a dev dependency: - -```bash -npm install -D archgate # or: bun add -d archgate -npx archgate check # run via package manager -``` - -**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options. +Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the **[installation guide](https://cli.archgate.dev/getting-started/installation/)** for all options and platform support. ## Quick start ```bash -# 1. Install -curl -fsSL https://cli.archgate.dev/install-unix | sh # or: npm install -g archgate - -# 2. Initialize governance in your project +# 1. Initialize governance in your project cd my-project archgate init -# 3. Edit the generated ADR to document a real decision +# 2. Edit the generated ADR to document a real decision # .archgate/adrs/ARCH-001-*.md -# 4. Add a companion .rules.ts to enforce it automatically +# 3. Add a companion .rules.ts to enforce it automatically # .archgate/adrs/ARCH-001-*.rules.ts -# 5. Run checks +# 4. Run checks archgate check ```