@variantic/player 0.0.23 → 0.0.25

package/README.md

@@ -6,10 +6,10 @@ Future versions will introduce functionalities for controlling the embedded play
 
 ## 📦 Installation
 
-You can install this package via npm:
+Install this type-only package as a development dependency:
 
 ```sh
-npm install @variantic/player
+npm install --save-dev @variantic/player
 ```
 
 ## 🚀 Usage
@@ -17,7 +17,7 @@ npm install @variantic/player
 Import the necessary types into your TypeScript project:
 
 ```ts
-import { TSnapshotUrl } from '@variantic/player';
+import type { TSnapshotUrl } from '@variantic/player';
 
 const snapshotUrl: TSnapshotUrl = {
 	url: 'testUrl',
@@ -25,6 +25,38 @@ const snapshotUrl: TSnapshotUrl = {
 };
 ```
 
+## Assembly player (player-ng)
+
+Use the `/assembly` entrypoint for the assembly player's public API, query store,
+and addon types:
+
+```ts
+import type { TPlayerComponent } from '@variantic/player/assembly';
+
+await customElements.whenDefined('variantic-player-ng');
+
+const player = document.querySelector('variantic-player-ng') as TPlayerComponent | null;
+if (!player) {
+	throw new Error('The player element was not found');
+}
+await player.api.ready();
+
+console.log('Current status:', player.api.query.get('status'));
+
+const unsubscribe = player.api.query.subscribe('status', (status) => {
+	console.log('Player status:', status);
+});
+
+// Call this when your integration is disposed.
+function destroyPlayerIntegration() {
+	unsubscribe();
+}
+```
+
+Run this setup after embedding `<variantic-player-ng>` and loading its script.
+`api.ready()` waits for addon APIs, the initial scene, and query state, including
+when the player has already finished initializing.
+
 ## 📜 License
 
 This package is licensed under the MIT License. See [LICENSE](./LICENSE) for details.