covekit 0.1.0 → 0.1.2

package/README.md

@@ -137,3 +137,19 @@ new CoveKitRoom(client: CoveKitClient, events: CoveKitRoomEvents)
 * `sendWhiteboardUpdate(elements: any)`: Broadcasts real-time collaborative whiteboard updates to peers.
 * `kickParticipant(peerId: string)`: *[Host Only]* Evicts a participant from the room.
 * `endMeetingRoom()`: *[Host Only]* Terminates the meeting session for everyone.
+
+---
+
+## Authentication & Security
+
+To prevent unauthorized access and protect your resources, CoveKit utilizes a two-tier authentication architecture:
+
+1. **Backend Server (Private - API Key)**: 
+   Your backend server manages meeting room creation and participant authorization. Secure these API requests from your server to the Control Plane by sending your secret API key in the `X-API-Key` header.
+   
+   > [!WARNING]
+   > **Never expose your `X-API-Key` in client-side code (browsers).** Doing so allows anyone to create rooms, fetch session logs, or abuse your account.
+
+2. **Client-Side SDK / Iframe (Public - Room IDs)**:
+   The client-side `covekit` SDK and the iframe embed only require the public `room` (publicId) and optionally a passcode. The client-side client handles WebRTC signaling and media stream loops using public, session-specific endpoints without exposing your secret API key.
+

package/package.json

@@ -1,8 +1,22 @@
 {
   "name": "covekit",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "description": "Official SDK for CoveKit Video Meetings, real-time media tracks, and collaborative whiteboard suites.",
+  "keywords": [
+    "webrtc",
+    "mediasoup",
+    "video-meetings",
+    "video-conferencing",
+    "whiteboard",
+    "realtime",
+    "covekit",
+    "sdk",
+    "embed",
+    "collaboration"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "license": "MIT",
   "files": [
     "dist"
   ],