@playcademy/sdk 0.1.17 → 0.2.0

package/README.md

@@ -14,6 +14,54 @@ The SDK serves as the primary interface between your game and the Playcademy pla
 - **Event System**: Real-time notifications for inventory changes, level ups, and more
 - **Developer Tools**: Built-in support for game development and testing workflows
 
+### Public vs Internal SDK
+
+The Playcademy SDK is split into two entry points:
+
+#### Public SDK (`@playcademy/sdk`)
+
+For game developers building games on the Playcademy platform. Includes 8 essential namespaces:
+
+- **Core**: `identity`, `runtime`, `backend`, `users`
+- **Economy**: `credits`
+- **Gameplay**: `scores`
+- **Multiplayer**: `realtime`
+- **Integrations**: `timeback`
+
+```typescript
+import { PlaycademyClient } from '@playcademy/sdk'
+
+const client = await PlaycademyClient.init()
+await client.timeback.endActivity({
+    /* ... */
+})
+await client.users.inventory.add('gold-coin', 100)
+```
+
+#### Internal SDK (`@playcademy/sdk/internal`)
+
+For CLI, platform, and admin tools. Includes all 21 namespaces (8 public + 13 internal):
+
+**Additional internal namespaces:**
+
+- **Platform Auth**: `auth` (email/password login, API keys)
+- **Administration**: `admin` (game management, items, currencies)
+- **Developer Tools**: `dev` (publish games, uploads)
+- **Game Directory**: `games` (fetch, list, sessions)
+- **Overworld Features**: `character`, `achievements`, `leaderboard`, `levels`, `shop`, `maps`, `sprites`, `notifications`
+- **Analytics**: `telemetry`
+
+```typescript
+import { PlaycademyClient } from '@playcademy/sdk/internal'
+
+const client = new PlaycademyClient({ baseUrl: 'https://hub.playcademy.net' })
+await client.auth.login({ email: 'dev@example.com', password: '***' })
+const games = await client.games.list()
+await client.admin.games.pauseGame('game-123')
+```
+
+**Note**: The internal SDK is for trusted code only (CLI, platform internals). Game developers should use the public SDK.
+
 ### Key Benefits
 
 - **Zero Configuration**: Automatic initialization with environment detection
@@ -40,7 +88,7 @@ The SDK automatically monitors network connectivity and provides hooks for games
 - **Platform Integration**: Built-in helpers for displaying connection alerts
 - **Zero Config**: Works out of the box, customizable when needed
 
-See [DISCONNECT_HANDLING.md](./DISCONNECT_HANDLING.md) for detailed documentation and examples.
+See the SDK Browser documentation for detailed connection monitoring documentation and examples.
 
 ## Installation