From 323100814ea5fe08a7b0b7ef02ff81ead948d5f5 Mon Sep 17 00:00:00 2001 From: Boot Date: Wed, 5 Aug 2026 17:38:21 +0800 Subject: [PATCH] docs: add Install section to README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Agents receiving the GitHub link need clear install instructions. Pin to github: source — npm registry name is unoccupied and has squatting/poisoning risk, so never document bare `npm install`. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 9c1cb55..a7f8d56 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,19 @@ Manages Ed25519 key pairs (keygen, registration, rotation) and signs outgoing HTTP requests with RFC-9421-shaped signatures that are byte-identical to the Go `agentsig` verifier in `platform/internal/agentsig`. +## Install + +Zero runtime dependencies, pure ESM, no build step. Install from GitHub, pinned +to a release: + +```bash +npm install github:openmaxai/openmax-agentgate#v0.2.0 +``` + +This provides both the `agentgate` CLI (verify with `npx agentgate --version`) +and the library import (`import { createSigner } from 'openmax-agentgate/client'`). +Check for updates any time: `npx agentgate upgrade --check`. Requires Node.js >= 20. + ## CLI ```bash