Skip to content

docs: add Install section to README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
owen0x6f merged 1 commit into from
Aug 5, 2026
Merged

docs: add Install section to README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading