@benchsdk/client 0.3.0 → 0.5.2

package/README.md

@@ -1,5 +1,7 @@
 # @benchsdk/client
 
+> **Backwards-compatibility shim.** `@benchsdk/client` re-exports the full `@benchsdk/runner` surface and preserves the legacy `createBenchmarkClient().runWorker(options)` spelling. New projects should import from `@benchsdk/runner` for authoring/operator helpers or `@benchsdk/api` for raw REST types.
+
 Client and worker helpers for the ComputeSDK benchmark orchestrator.
 
 This package talks to the platform-owned benchmark/run/participant/worker API. It does not mint canonical run, worker, attempt, event, or task IDs. Workers claim platform-assigned work, execute task indexes in their assigned range, and send `task_results` batches back to the platform.
@@ -15,6 +17,12 @@ npm install @benchsdk/client
 > [`@benchsdk/runner`](../benchsdk-runner). This package is REST transport plus
 > the worker engine only.
 
+## Authentication
+
+`createBenchmarkClient` requires a platform API key or OAuth token. Provide
+`apiKey`/`token` directly, or set `BENCHMARKS_PLATFORM_API_KEY` or
+`BENCHMARKS_PLATFORM_TOKEN` in the environment.
+
 ## Run A Worker
 
 ```ts
@@ -22,7 +30,7 @@ import { createBenchmarkClient } from '@benchsdk/client';
 import { compute } from 'computesdk';
 
 const client = createBenchmarkClient({
-  apiKey: process.env.COMPUTESDK_ADMIN_API_KEY,
+  apiKey: process.env.BENCHMARKS_PLATFORM_API_KEY,
 });
 
 // `task` is a raw function; declare named steps imperatively via `step(...)`,
@@ -62,7 +70,7 @@ Task results are flushed to the platform in batches of 1,000 records by default.
 import { createBenchmarkClient } from '@benchsdk/client';
 
 const client = createBenchmarkClient({
-  apiKey: process.env.COMPUTESDK_ADMIN_API_KEY,
+  apiKey: process.env.BENCHMARKS_PLATFORM_API_KEY,
 });
 
 await client.upsertBenchmark('scale', {
@@ -196,7 +204,7 @@ For coordinator health artifacts, sample system metrics:
 
 ```ts
 const metrics = createSystemMetricsCollector();
-const samples = [metrics.sample()];
+const samples = [await metrics.sample()];
 metrics.stop();
 ```