From 189676195231a85b1908d9b594e3166abe592a49 Mon Sep 17 00:00:00 2001 From: Mateus Andrade Date: Thu, 30 Jul 2026 20:30:07 -0300 Subject: [PATCH] docs(readme): lead with npx as the install-free entry point MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The quickstart assumed an already-installed `scc` binary while the npm package — the way most people will actually reach it — was explained 25 lines below. Run the four commands through `npx @protonspy/scc` and note the global-install shorthand instead. Install now links the published package, says why there is no toolchain to set up (the launcher resolves the platform binary as an optional dependency), and shows the pinned form for CI. Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_01K2uD2SD6syaoXnhtqHbzhM --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9a5a0eb..cf2dcce 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,18 @@ workflow into a mechanically validated contract for humans and AI agents. ## Use it +No install — run it straight from npm inside the repo you want to govern: + ```bash -scc init # scaffold .claude/rules/, the review agents, the layout -scc spec new user-auth # specs/user-auth/: requirements.md, design.md, tasks.md -scc plan new checkout-revamp # plans/checkout-revamp.md -scc validate # every check; exit 2 means it found something +npx @protonspy/scc init # scaffold .claude/rules/, the review agents, the layout +npx @protonspy/scc spec new user-auth # specs/user-auth/: requirements.md, design.md, tasks.md +npx @protonspy/scc plan new checkout-revamp # plans/checkout-revamp.md +npx @protonspy/scc validate # every check; exit 2 means it found something ``` +Installed globally (`npm i -g @protonspy/scc`) the same commands are just `scc init`, +`scc spec new user-auth`, and so on. + | Command | What it does | |---|---| | `init` | Scaffolds the workspace and records what it wrote. Idempotent; never overwrites your edits. | @@ -38,8 +43,13 @@ accountability, and a checker that was confidently incomplete would be worse tha ## Install +Published on npm as [`@protonspy/scc`](https://www.npmjs.com/package/@protonspy/scc) — +the launcher pulls the right prebuilt binary for your platform as an optional dependency, +so there is no toolchain to set up. + ```bash -npx @protonspy/scc help # no install +npx @protonspy/scc help # no install; pins nothing, always the latest +npx @protonspy/scc@0.0.1 help # pin a version (CI) npm i -g @protonspy/scc # then: scc help ```