@pathmx/cloudflare 0.5.0 → 0.5.1

package/README.md

@@ -1,60 +1,58 @@
-# @pathmx/cloudflare
+# `@pathmx/cloudflare`
 
-Opt-in publication plugin for deploying PathMX static publications as a
-Cloudflare Worker with Static Assets.
+Publish a static PathMX build as a Cloudflare Worker with Static Assets.
+
+## Install
+
+```sh
+bun run pmx plugins add cloudflare
+```
+
+Configure the publication in a repository Plugin:
 
 ```ts
 // plugins/cloudflare.plugin.ts
 import { CloudflarePlugin } from "@pathmx/cloudflare"
 
 export default CloudflarePlugin({
-  accountId: "0123456789abcdef0123456789abcdef",
   worker: "my-pathmx-site",
   origin: "https://docs.example.com",
-  basePath: "/course-guide",
+  domain: "docs.example.com",
+})
+```
+
+Set `accountId` when local Cloudflare credentials can access more than one
+account. Use `basePath` when PathMX should live below an origin prefix such as
+`/course-guide`.
+
+Custom Domains are the default. To attach an exact Worker route in an existing
+zone instead:
+
+```ts
+export default CloudflarePlugin({
+  worker: "my-pathmx-site",
+  origin: "https://docs.example.com",
   domain: "docs.example.com",
   routing: { type: "route", zone: "example.com" },
 })
 ```
 
-`basePath` mounts every canonical PathMX route—including exact Markdown,
-runtime assets, polling records, and discovery documents—under one prefix. It
-is useful when a PathMX publication lives beside another application on the
-same origin.
-
-Set `accountId` when local credentials can access more than one Cloudflare
-account. It is written to the generated Wrangler configuration so validation
-and deployment select the same account.
-
-Domains default to Cloudflare Custom Domains. Select zone-route routing when
-an existing Worker route must run before the domain; PathMX emits the exact
-`docs.example.com/*` route so it outranks broader wildcard routes in that zone.
-
-For a sibling source checkout, keep both packages local and override peer
-resolution until they are published:
-
-```json
-{
-  "dependencies": {
-    "@pathmx/cloudflare": "file:../minipathmx/pathmx/cloudflare",
-    "pathmx": "file:../minipathmx/pathmx/core"
-  },
-  "overrides": {
-    "pathmx": "file:../minipathmx/pathmx/core"
-  }
-}
+## Publish
+
+Stage and validate without deploying:
+
+```sh
+bun run pmx cloudflare publish
 ```
 
-Stage locally by default. Validation invokes pinned Wrangler without deploying;
-deployment is the only command that mutates Cloudflare state.
+Preview the work without writing the managed stage:
 
 ```sh
-pmx cloudflare publish
-pmx cloudflare publish --dry-run
-pmx cloudflare publish --deploy
+bun run pmx cloudflare publish --dry-run
 ```
 
-The managed stage is written to `.pathmx/publish/cloudflare/`. Its generated
-Worker applies the canonical publication route manifest, including Markdown
-content negotiation and exact `.md` routes, before fetching immutable bodies
-from the Static Assets binding.
+Deploy after validation succeeds:
+
+```sh
+bun run pmx cloudflare publish --deploy
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pathmx/cloudflare",
   "description": "Cloudflare publication support for PathMX.",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "license": "SEE LICENSE IN LICENSE.md",
   "repository": {
     "type": "git",