@evident-ai/runner-cdk 0.1.0 → 0.1.1-dev.d96ef8a

package/README.md

@@ -1,12 +1,19 @@
 # `@evident-ai/runner-cdk`
 
-A reusable AWS CDK construct for running **one scale-to-zero [Evident](https://evident.run)
-agent runner** on Fargate, in **your** AWS account, against **your** repo.
-
-The runner sleeps when nobody is talking to it: after `idleTimeoutSeconds` of inactivity
-the task scales its own service to `desiredCount 0`, and an HMAC-authenticated waker
-Lambda scales it back up on the next message. You pay for the time the agent is actually
-working.
+Reusable AWS CDK constructs for running an [Evident](https://evident.run) agent runner in
+**your** AWS account, against **your** repo. Two runner strategies:
+
+- **`EvidentScaleToZeroConstruct`** — **one scale-to-zero agent runner** on Fargate,
+  covered by the rest of this README. The runner sleeps when nobody is talking to it:
+  after `idleTimeoutSeconds` of inactivity the task scales its own service to
+  `desiredCount 0`, and an HMAC-authenticated waker Lambda scales it back up on the next
+  message. You pay for the time the agent is actually working.
+- **`EvidentMicrovmConstruct`** — a per-session AWS Lambda MicroVM that boots on demand
+  and suspends between messages. It is not yet at Fargate's install-only parity here:
+  building its runner image still means cloning the `sroze/evident` repo (tracked in
+  [#1528](https://github.com/sroze/evident/issues/1528)). See
+  [the AWS runner doc](https://evident.run/docs/aws-runner) for the full picture of both
+  strategies.
 
 ## What it creates
 
@@ -108,14 +115,12 @@ built from a `Dockerfile` you control. The generic runner image lives separately
 
 ## Status / limitations
 
-- **Publishable, but not yet published.** The package is `@evident-ai/runner-cdk`
-  (MIT), buildable to a self-contained `dist/` (`pnpm --filter @evident-ai/runner-cdk
-  build`) with no `workspace:`/`@evident/*` runtime dependency — see
-  [#957](https://github.com/sroze/evident/issues/957). The **first** `npm publish` is a
-  one-time human bootstrap step (OIDC/Trusted Publishing can't perform a package's
-  first publish, same as [#612](https://github.com/sroze/evident/issues/612) was for
-  `@evident-ai/runner-synchroniser`) and hasn't happened yet; until then this repo's own
-  consumer (`infrastructure/evident-runner`) keeps consuming it as a `workspace:*`
-  dependency, and following this guide outside this repo means working from a checkout.
+- **Published to npm** as `@evident-ai/runner-cdk` (MIT) — see
+  [#957](https://github.com/sroze/evident/issues/957). Install it with `npm install
+  @evident-ai/runner-cdk` (or `pnpm add`/`yarn add`); no checkout of this repo is
+  required. It builds to a self-contained `dist/` (`pnpm --filter @evident-ai/runner-cdk
+  build`) with no `workspace:`/`@evident/*` runtime dependency. This repo's own
+  consumer (`infrastructure/evident-runner`) still consumes it as a `workspace:*`
+  dependency for dogfooding.
 - **AWS/ECS-specific.** Non-AWS clouds are an open question on the epic, not a supported
   path.