Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 0 additions & 68 deletions CHANGELOG.md

This file was deleted.

21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,9 @@ authoring.
| Prism live control panel | `control` | Scene + operator overlay |
| Editor preview iframe | `test` | Scene + adapter mocker + state inspector |

## Three consumers, one API

The same bundle backs three hosts with two public entry points :
## Public API

```ts
// Live host — Pulsar CEF browser source, Prism live control panel,
// editor preview iframe. Drives off Orion's WS state stream.
import { mount } from "@zablab/solar";

const handle = mount({
Expand All @@ -31,20 +27,13 @@ const handle = mount({
token: showToken,
mode: "broadcast",
});
```

```ts
// Web embed — any HTML page, no Pulsar / CEF / Electron. Drives off
// a Prism-exported sceneJson + named animations.
import { PrismScene } from "@zablab/solar";

const scene = new PrismScene({ sceneJson });
scene.mount(document.querySelector("#container")!);
scene.playAnimation("Score Update", { score_to: 1891 });
// later
handle.setToken(rotatedToken);
handle.disconnect();
```

Full integration guide : [`docs/embed-on-website.md`](./docs/embed-on-website.md).
Action descriptor reference : [`docs/action-descriptors.md`](./docs/action-descriptors.md).
The complete typed surface lives in `src/types/index.ts`.

## Status

Expand Down
163 changes: 0 additions & 163 deletions docs/action-descriptors.md

This file was deleted.

Loading
Loading