quilt-sdk 0.0.5 → 0.0.6

package/README.md

@@ -74,19 +74,49 @@ Primary SDK surfaces:
 - `client.events` for SSE streams
 - `client.raw(...)` for authenticated access to backend routes that are intentionally still exposed as raw contract calls
 
+## Docker-Compatible Images
+
+Quilt supports Docker-compatible registry image ingress through the OCI image routes and normal container create.
+
+That means:
+
+- pull an image from Docker Hub or another OCI-compatible registry
+- inspect or list the stored image metadata
+- create a container from that pulled image with `oci: true`
+
+This is image compatibility, not Docker Engine API compatibility.
+
+Registry pull:
+
+```ts
+const pulled = await client.platform.ociPull({
+  reference: "docker.io/library/alpine:3.20",
+});
+```
+
+Create from the pulled image:
+
+```ts
+const accepted = await client.containers.create(
+  {
+    name: "oci-demo",
+    image: "docker.io/library/alpine:3.20",
+    oci: true,
+    command: ["sleep", "60"],
+  },
+  "async",
+);
+```
+
 ## Public Types
 
-The SDK ships declarations automatically.
+The SDK ships declarations automatically through the package export.
 
 Use the client-owned type surface when you need explicit types:
 
 ```ts
 import { QuiltClient } from "quilt-sdk";
 
-const client = QuiltClient.connect({
-  apiKey: process.env.QUILT_API_KEY,
-});
-
 const options: QuiltClient.Options = {
   baseUrl: "https://backend.quilt.sh",
   apiKey: process.env.QUILT_API_KEY,
@@ -138,21 +168,25 @@ ws.addEventListener("message", (msg) => {
 
 ## Examples
 
-The repo ships production-validated examples in [examples/README.md](/home/ubuntu/quilt-sdk/examples/README.md).
+The repository ships a production-validated example set in [`examples/`](./examples).
 
 Example files:
 
 - `examples/containers-volumes-and-network.ts`
+- `examples/docker-and-oci-images.ts`
 - `examples/sdk-runtime-and-functions.ts`
 - `examples/clusters-nodes-workloads-and-k8s.ts`
 - `examples/terminal-and-icc.ts`
 - `examples/elasticity-control.ts`
 - `examples/lifecycle-and-failures.ts`
 
+The example guide is in [`examples/README.md`](./examples/README.md).
+
 Run them from the repo root:
 
 ```bash
 bun run example:containers
+bun run example:images
 bun run example:sdk
 bun run example:clusters
 bun run example:terminal
@@ -185,6 +219,28 @@ bun run build
 bun run examples:all
 ```
 
+`prepublishOnly` runs:
+
+```bash
+bun run clean
+bun run lint
+bun run typecheck
+bun run examples:typecheck
+bun run test
+bun run build
+```
+
+## Package Contents
+
+The published npm package includes:
+
+- compiled runtime in `dist/`
+- generated `.d.ts` declarations
+- `README.md`
+- `LICENSE`
+
+The repository also includes the example app and validation setup used to verify the SDK against production.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quilt-sdk",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Fully type-safe TypeScript SDK for Quilt HTTP APIs",
   "type": "module",
   "main": "./dist/index.js",
@@ -27,14 +27,15 @@
     "lint:fix": "biome check --write .",
     "test": "bun test",
     "test:coverage": "bun test --coverage",
-    "examples:all": "bun run example:containers && bun run example:sdk && bun run example:clusters && bun run example:terminal && bun run example:elasticity && bun run example:lifecycle",
+    "examples:all": "bun run example:containers && bun run example:images && bun run example:sdk && bun run example:clusters && bun run example:terminal && bun run example:elasticity && bun run example:lifecycle",
     "example:containers": "node --env-file=.env --import tsx examples/containers-volumes-and-network.ts",
+    "example:images": "node --env-file=.env --import tsx examples/docker-and-oci-images.ts",
     "example:sdk": "node --env-file=.env --import tsx examples/sdk-runtime-and-functions.ts",
     "example:clusters": "node --env-file=.env --import tsx examples/clusters-nodes-workloads-and-k8s.ts",
     "example:terminal": "node --env-file=.env --import tsx examples/terminal-and-icc.ts",
     "example:elasticity": "node --env-file=.env --import tsx examples/elasticity-control.ts",
     "example:lifecycle": "node --env-file=.env --import tsx examples/lifecycle-and-failures.ts",
-    "prepublishOnly": "bun run clean && bun run lint && bun run typecheck && bun run test && bun run build"
+    "prepublishOnly": "bun run clean && bun run lint && bun run typecheck && bun run examples:typecheck && bun run test && bun run build"
   },
   "keywords": ["quilt", "sdk", "api", "typescript", "bun"],
   "license": "MIT",
@@ -49,5 +50,8 @@
     "tsx": "^4.20.3",
     "typescript": "^5.8.3",
     "ws": "^8.20.0"
+  },
+  "dependencies": {
+    "quilt-sdk": "^0.0.5"
   }
 }