@playcademy/sdk 0.2.1 → 0.2.2

package/README.md

@@ -221,9 +221,19 @@ console.log(`Level ${userLevel.currentLevel}, ${progress.xpToNextLevel} XP to ne
 
 ### TimeBack Integration
 
-Track learning activities and automatically calculate XP based on time spent and accuracy:
+Access user role and enrollments, and track learning activities:
 
 ```typescript
+// Access TimeBack role and enrollments
+const role = client.timeback.role // 'student' | 'parent' | 'teacher' | 'administrator'
+const enrollments = client.timeback.enrollments // [{ subject, grade, courseId }]
+
+// Check if user is enrolled in a specific grade
+const grade3Enrollment = enrollments.find(e => e.grade === 3)
+if (grade3Enrollment) {
+    // Show grade 3 content
+}
+
 // Start tracking an activity (only activityId required!)
 client.timeback.startActivity({
     activityId: 'math-quiz-level-1',
@@ -242,24 +252,16 @@ await client.timeback.endActivity({
 // 100%: 1.25x | 80-99%: 1.0x | 65-79%: 0.5x | <65%: 0x
 ```
 
-### Real-time Communication
+### Real-time Authentication
 
-Open a direct, low-latency communication channel for your game, perfect for multiplayer interactions.
+Get authentication tokens for WebSocket connections used by the platform's multiplayer system.
 
 ```typescript
-// Open a channel scoped to the current game
-const channel = await client.realtime.open('lobby-chat')
-
-// Send messages to other players in the channel
-channel.send({ type: 'chat', message: 'Hello, world!' })
-
-// Listen for incoming messages
-channel.onMessage(data => {
-    console.log('Received message:', data)
-})
+// Get a realtime token for WebSocket authentication
+const { token } = await client.realtime.token.get()
 
-// Remember to close the channel when it's no longer needed
-// channel.close()
+// Token is used internally by the platform's multiplayer WebSocket client
+// for presence tracking, player positions, and real-time game features
 ```
 
 ## API Reference
@@ -315,11 +317,12 @@ channel.onMessage(data => {
 
 #### **Real-time** (`client.realtime`)
 
-- `open(channelName?)`: Opens a game-scoped WebSocket channel.
-- `token.get()`: Retrieves a JWT for the real-time service.
+- `token.get()`: Retrieves a JWT for WebSocket authentication (used by the platform's multiplayer system).
 
 #### **TimeBack** (`client.timeback`)
 
+- `role`: The user's TimeBack role (`'student'`, `'parent'`, `'teacher'`, or `'administrator'`)
+- `enrollments`: Array of course enrollments with `subject`, `grade`, and `courseId`
 - `startActivity(metadata)`: Start tracking an activity (stores start time and metadata)
     - `metadata.activityId`: Unique activity identifier (required)
     - `metadata.activityName`: Human-readable activity name