Skip to content

Commit d06c74e

Browse files
gcmsgclaude
andcommitted
docs: add ZeroClaw plugin, missing API methods and Options to README
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 983aeda commit d06c74e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ The agent SDK defines a `platform.Adapter` interface that lets PeerClaw agents r
5454
- [**ironclaw-plugin**](https://github.com/peerclaw/ironclaw-plugin) — IronClaw (Rust WASM, HTTP/SSE)
5555
- [**picoclaw-plugin**](https://github.com/peerclaw/picoclaw-plugin) — PicoClaw (Go, native)
5656
- [**nanobot-plugin**](https://github.com/peerclaw/nanobot-plugin) — NanoBot (Python)
57+
- [**zeroclaw-plugin**](https://github.com/peerclaw/zeroclaw-plugin) — ZeroClaw (Rust, WebSocket)
5758

5859
See each plugin's README for configuration and usage details.
5960

@@ -144,6 +145,12 @@ for _, r := range results {
144145
| `agent.GetTransfer(fileID)` | Get status of a specific file transfer |
145146
| `agent.CancelTransfer(fileID)` | Cancel an in-progress file transfer |
146147
| `agent.OnConnectionRequest(handler)` | Register a callback for connection requests from unknown peers |
148+
| `agent.NewSimple(name, url, caps)` | Create a minimal Agent (no Nostr/DHT) |
149+
| `agent.Keypair()` | Get the Ed25519 keypair |
150+
| `agent.TrustStore()` | Get the trust store |
151+
| `agent.Router()` | Get the capability-based router |
152+
| `agent.SetNotificationHandler(h)` | Register handler for server notifications |
153+
| `agent.Sessions()` | List active peer sessions |
147154

148155
### Options
149156

@@ -159,6 +166,11 @@ for _, r := range results {
159166
| `FileTransferDir` | Directory for received files (defaults to current directory) |
160167
| `ResumeStatePath` | Path to persist file transfer resume state |
161168
| `Logger` | Structured logger |
169+
| `ClaimToken` | Claim token for account-bound registration |
170+
| `HealthCheck` | Callback reporting agent status before each heartbeat |
171+
| `PlatformAdapters` | List of platform adapters to enable (OpenClaw, IronClaw, etc.) |
172+
| `InboxRelays` | Nostr relay URLs for offline message delivery (mailbox) |
173+
| `ConnectionGate` | Callback to accept/deny unknown peer connections |
162174

163175
## Security Model
164176

0 commit comments

Comments
 (0)