@markii/host 0.17.0-next.3 → 0.17.0-next.5

package/README.md

@@ -10,13 +10,46 @@ load, trust and removal, export, completion, hover and component insertion.
 Entries:
 
 - `@markii/host`: environment-neutral; safe to bundle for a browser.
+- `@markii/host/internal`: for the reference apps. No compatibility
+  promise; do not build on it.
 - `@markii/host/browser`: a Web Worker isolate and a `fetch` network
   provider bound to an origin allowlist.
 - `@markii/host/node`: a worker-thread isolate (`createNodeHostIsolate`),
   the address-pinning network provider, and the Node file system seams.
+- `@markii/host/html-engine`: the HTML export engine. The one entry that
+  needs `@markii/html`.
+- `@markii/host/browser-worker-classic`: the Web Worker as a classic
+  script, for a host that starts it from a blob URL.
 - `@markii/host/node-worker`: the self-contained worker file, for a host
   that bundles the worker itself.
 - `@markii/host/conformance`: the host scenario corpus and its runner, to
   prove an adapter behaves like the reference apps.
 
-See `docs/integration.md` in the repository for how to write a host.
+A minimal browser host is one adapter and one call:
+
+```ts
+import { createMarkiiHost } from '@markii/host';
+import {
+  createBrowserHostIsolate,
+  createFetchNetProvider,
+} from '@markii/host/browser';
+
+const host = createMarkiiHost({
+  id: 'my-app',
+  labels,
+  readFile,
+  exists,
+  writeFile,
+  listFolder,
+  prompt: (request) => showDialog(request),
+  memento,
+  diagnostics: (line) => console.info(line),
+  now: () => Date.now(),
+  isolate: createBrowserHostIsolate({
+    netProvider: createFetchNetProvider({ allowedOrigins }),
+  }),
+});
+```
+
+See `docs/hosts.md` in the repository for the adapter fields, the host
+responsibilities and the reference hosts.