@smoregg/sdk 0.6.2 → 1.0.0

package/README.md

@@ -17,14 +17,15 @@ yarn add @smoregg/sdk
 ### Screen Game (TV/Display)
 
 ```tsx
-import { SmoreScreen } from '@smoregg/sdk';
+import { createScreen } from '@smoregg/sdk';
 
 function MyGame() {
-  const screen = new SmoreScreen({
+  const screen = createScreen({
     gameId: 'my-game',
     listeners: {
       tap: (playerIndex, data) => {
         console.log(`Player ${playerIndex} tapped!`);
+        screen.broadcast('score-update', { playerIndex, score: 10 });
       }
     }
   });
@@ -36,10 +37,10 @@ function MyGame() {
 ### Controller App (Mobile)
 
 ```tsx
-import { SmoreController } from '@smoregg/sdk';
+import { createController } from '@smoregg/sdk';
 
 function MyController() {
-  const controller = new SmoreController({
+  const controller = createController({
     gameId: 'my-game',
     listeners: {
       'state-update': (state) => {
@@ -59,7 +60,6 @@ function MyController() {
 ## Features
 
 - **Screen/Controller Communication**: Simple event-based messaging
-- **React Hooks**: `useGameHost`, `useGamePlayer` for React apps
 - **TypeScript Support**: Full type definitions included
 - **Testing Utilities**: Mock Screen and Controller for unit testing
 - **Multiple Formats**: ESM, CJS, and UMD builds
@@ -67,29 +67,38 @@ function MyController() {
 
 ## API Reference
 
-### SmoreScreen
+### createScreen()
 
-Screen-side game controller.
+Create a screen-side game instance.
 
 ```typescript
-const screen = new SmoreScreen({
+import { createScreen } from '@smoregg/sdk';
+
+const screen = createScreen({
   gameId: string;
   listeners?: Record<string, (playerIndex: number, data: any) => void>;
 });
 
 // Methods
 screen.broadcast(event: string, data: any): void
-screen.sendToPlayer(playerIndex: number, event: string, data: any): void
+screen.sendToController(playerIndex: number, event: string, data: any): void
+screen.gameOver(results: GameResults): void
 screen.on(event: string, callback: Function): void
 screen.off(event: string, callback: Function): void
+
+// Properties
+screen.controllers: Array<{ playerIndex: number; nickname: string; connected: boolean }>
+screen.myIndex: number
 ```
 
-### SmoreController
+### createController()
 
-Controller-side app.
+Create a controller-side game instance.
 
 ```typescript
-const controller = new SmoreController({
+import { createController } from '@smoregg/sdk';
+
+const controller = createController({
   gameId: string;
   listeners?: Record<string, (data: any) => void>;
 });
@@ -98,40 +107,22 @@ const controller = new SmoreController({
 controller.send(event: string, data: any): void
 controller.on(event: string, callback: Function): void
 controller.off(event: string, callback: Function): void
-```
-
-### React Hooks
 
-```typescript
-import { useGameHost, useGamePlayer } from '@smoregg/sdk';
-
-// Screen
-const { room, broadcast, sendToPlayer } = useGameHost({
-  gameId: 'my-game',
-  onInput: {
-    tap: (playerIndex, data) => { /* ... */ }
-  }
-});
-
-// Controller
-const { emit, room } = useGamePlayer({
-  gameId: 'my-game',
-  listeners: {
-    'state-update': (state) => { /* ... */ }
-  }
-});
+// Properties
+controller.myIndex: number
+controller.isLeader: boolean
 ```
 
 ## Backward Compatibility
 
-The old `SmoreHost` and `SmorePlayer` names are still available as aliases:
+The old type aliases are still available:
 
 ```typescript
-// These still work (deprecated)
-import { SmoreHost, SmorePlayer } from '@smoregg/sdk';
+// Old names (deprecated)
+import type { SmoreHost, SmorePlayer } from '@smoregg/sdk';
 
-// Prefer the new names
-import { SmoreScreen, SmoreController } from '@smoregg/sdk';
+// New names (preferred)
+import type { SmoreScreen, SmoreController } from '@smoregg/sdk';
 ```
 
 ## Testing