From 2004edb177718ca24173b55363d1dead7ab3f716 Mon Sep 17 00:00:00 2001 From: anthonyadame Date: Thu, 14 May 2026 12:41:27 -0400 Subject: [PATCH] fix(readme): correct npm install command + remove stale internal-runbook links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two small README cleanups: 1. The install matrix listed `npm install -g kaizen-cli`, but the published npm package (matching the PyPI and Homebrew naming) is `kaizen-3c-cli`. Anyone copy-pasting the previous command would hit a 404 from the npm registry. Updated to `npm install -g kaizen-3c-cli`. 2. The "Release process" section linked to two internal maintainer docs that exist in the private upstream repo but not in this public one: `docs/release/RELEASE_PROCESS.md` and `docs/release/PUBLIC_REPO_ALLOWLIST.md`. Both links 404 on GitHub. Removed the section entirely — public OSS users don't need to see the internal release process; advertising dead links is worse than omitting the explanation. No functional changes; no API or CLI behavior changes. Only README edits. Signed-off-by: anthonyadame --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 0b6c17c..578debe 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ | Method | Command | |---|---| | **winget** (Windows) | `winget install Kaizen3C.KaizenCLI` | -| **npm** | `npm install -g kaizen-cli` | +| **npm** | `npm install -g kaizen-3c-cli` | | **Homebrew** (macOS/Linux) | `brew tap Kaizen-3C/tap && brew install kaizen-cli` | | **pipx** (Python, recommended) | `pipx install kaizen-3c-cli` | | **uv** | `uv tool install kaizen-3c-cli` | @@ -106,7 +106,3 @@ The five agents (Researcher, Red Team, Draft, Write, Evaluator) iterate over the ### Developer setup See [quickstart.md](quickstart.md) for environment prerequisites, Docker Compose setup for the full stack, and first-run instructions. For CLI-only development, `pip install -e .` at the repo root is enough. - -### Release process - -The public `kaizen` repo is curated from this `kaizen-delta` dev repo via an allowlist-driven export script. Maintainer runbook: [docs/release/RELEASE_PROCESS.md](docs/release/RELEASE_PROCESS.md). The authoritative allowlist: [docs/release/PUBLIC_REPO_ALLOWLIST.md](docs/release/PUBLIC_REPO_ALLOWLIST.md).