@agentshouse/app-bridge 0.1.0-cf2e2ca943fbc → 0.1.0-cf6672d6a6842

package/README.md

@@ -1,22 +1,25 @@
 # @agentshouse/app-bridge
 
-The renderer-side client of the agents.house App bridge. An App served by House
-receives one message port before its own scripts run; this package is that
-port's one listener. It carries eleven families: navigation, ceremonies,
-installation, notifications, status, Site image reads, App release code,
-external calls, App messages and App and Site screenshot reads.
+The types of the agents.house App bridge, an accessor and an in-page test host.
+House builds the bridge object in every App it serves and hands it to the page
+before the App's own scripts run; `houseBridge()` returns that object, so an App
+carries no bridge code of its own. It carries eleven families: navigation,
+ceremonies, installation, notifications, status, Site image reads, App release
+code, external calls, App messages and App and Site screenshot reads.
 [docs/families.md](docs/families.md) describes each and the test host.
 
-The package carries no credential handling and no Runtime family. House builds
+The bridge carries no credential handling and no Runtime family. House builds
 the MD Runtime client into the page beside the bridge, and `bridge.runtime`
 resolves to that client, so the App imports and constructs none.
 
+House's `find_command` "App" is the guide to building an App or a Site.
+
 ## Use
 
 ```js
-import { connectHouseBridge } from '@agentshouse/app-bridge';
+import { houseBridge } from '@agentshouse/app-bridge';
 
-const bridge = connectHouseBridge();
+const bridge = houseBridge();
 const md = await bridge.runtime;
 
 bridge.onAddress((address) => render(address));
@@ -32,22 +35,24 @@ async function manageSecurity(securityPath) {
   try {
     await bridge.ceremony(securityPath);
   } catch (refusal) {
-    report(refusal);
+    if (refusal.name === 'HouseCeremonyRefused') report(refusal.path);
   }
 }
 ```
 
-`bridge.runtime` resolves to the `MdRuntimeClient` of
-`@agentshouse/mdruntime/client`, whose README describes its members.
+`bridge.runtime` resolves to the `MdRuntimeClient` of `@agentshouse/mdruntime/client`,
+whose README describes its members. Its `call(method, params)` is a remote procedure call
+to a House act, such as `call('member.list', { room_ref })`: `HouseMethods` names each
+with its `params`, `HouseParams<Name>`, and its `result`, `HouseResult<Name>`.
 
 ## Test without a House
 
 ```js
-import { connectHouseBridge } from '@agentshouse/app-bridge';
+import { houseBridge } from '@agentshouse/app-bridge';
 import { createHouseBridgeTestHost } from '@agentshouse/app-bridge/test-host';
 
 const host = createHouseBridgeTestHost({ address: '/rooms/atlas' });
-const bridge = connectHouseBridge(host);
+const bridge = houseBridge();
 
 bridge.push('/rooms/atlas/members');
 host.open('/rooms/atlas');