@standardagents/sip 0.13.1 → 1.0.0

package/README.md

@@ -17,6 +17,40 @@
 pnpm add @standardagents/sip
 ```
 
+## Docs Site
+
+The repo includes a small static documentation site built with Arrow and Vite.
+
+```bash
+pnpm docs:dev
+pnpm docs:build
+pnpm docs:preview
+```
+
+- Source files live in `docs/`
+- The production build outputs to `docs-dist/`
+
+## Release
+
+Publishing is handled by GitHub Actions with npm trusted publishing. The workflow
+publishes from version tags and does not use an `NPM_TOKEN`.
+
+```bash
+pnpm verify
+pnpm verify:release
+pnpm release
+pnpm release:next
+pnpm release:dev
+```
+
+- `pnpm release` on `main` bumps `package.json`, commits the new stable version, and pushes the branch plus the `vX.Y.Z` tag
+- `pnpm release:next` and `pnpm release:dev` create a temporary tagged commit like `v1.1.1-next.231fa`, push only the tag, then restore your local branch to the original version
+- You can pass `--bump=major|minor|patch` and `--tag=<dist-tag>` to the release script directly
+- Stable tags create GitHub release notes after a successful npm publish; pre-release tags skip that step
+
+Trusted publishing must be configured in npm for the `standardagents/sip`
+repository and `.github/workflows/publish.yml`.
+
 ## Usage
 
 ```typescript
@@ -131,7 +165,6 @@ cd emsdk && ./emsdk install latest && ./emsdk activate latest
 source ./emsdk_env.sh
 
 # Build WASM
-cd packages/sip
 pnpm build:wasm
 ```
 
@@ -141,19 +174,22 @@ This downloads libjpeg-turbo, compiles it to WASM, and generates:
 
 ### Using WASM
 
-To enable streaming mode, register the WASM loader before processing:
+For Workers and bundlers, statically import the emitted `.wasm` asset and pass it
+to `ready()` once at startup:
 
 ```typescript
-import { sip } from '@standardagents/sip';
-import createSipModule from '@standardagents/sip/dist/sip.js';
+import { ready, transform, collect } from '@standardagents/sip';
+import sipWasm from '@standardagents/sip/dist/sip.wasm';
 
-// Register WASM loader (once at startup)
-globalThis.__SIP_WASM_LOADER__ = async () => createSipModule();
+await ready({ wasm: sipWasm });
 
-// Now sip.process() will use streaming for JPEG
-const result = await sip.process(jpegBuffer, { maxWidth: 2048 });
+const image = transform(request.body ?? request, { width: 2048, height: 2048 });
+const result = await collect(image);
 ```
 
+The `globalThis.__SIP_WASM_LOADER__` hook still exists as an internal escape hatch,
+but it is not the intended public setup API.
+
 ## Architecture
 
 ```