@ravenkash/rtc 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# @ravenkash/rtc
+
+Raven's browser RTC SDK — join a room, publish camera and microphone,
+subscribe to remote media. Hides SDP, ICE, STUN, TURN and the media server
+behind a small typed API.
+
+Part of [Raven](https://github.com/atulsinghhhh/Raven), open-source real-time communication infrastructure.
+
+## Install
+
+```bash
+npm install @ravenkash/rtc
+```
+
+## Use
+
+The token and endpoint come from your own backend — never mint them in a
+browser. See [`@ravenkash/server`](https://www.npmjs.com/package/@ravenkash/server)
+or [`raven-sdk`](https://pypi.org/project/raven-sdk/) for Python.
+
+```ts
+import { createRTCClient } from '@ravenkash/rtc';
+
+const client = createRTCClient({
+  token: grant.token,
+  endpoint: grant.endpoint,       // Raven's signaling WebSocket
+  iceServers: grant.iceServers,   // forward as-is; never hand-build STUN/TURN config
+});
+
+const room = await client.join(roomId);
+
+await room.enableCamera();
+await room.enableMicrophone();
+
+room.on('trackSubscribed', (track) => {
+  document.body.appendChild(track.attach());
+});
+```
+
+`join()` resolves once the **control plane** admits you. You can publish
+immediately, but ICE and DTLS finish a moment later — render from the
+`connected` event rather than assuming:
+
+```ts
+room.on('connected', () => setStatus('live'));
+// or, if you must block: await room.waitUntilConnected();
+```
+
+## Exports
+
+`createRTCClient`, `RTCClient`, `Room`, `Participant`,
+`LocalParticipant`, `RemoteParticipant`, `Track`, `LocalTrack`,
+`RemoteTrack`, `RTCError`, `isRTCError`.
+
+## Documentation
+
+- [Browser SDK reference](https://github.com/atulsinghhhh/Raven/blob/main/docs/sdk.md)
+- [RTC architecture](https://github.com/atulsinghhhh/Raven/blob/main/docs/rtc/architecture.md)
+- [Signaling protocol](https://github.com/atulsinghhhh/Raven/blob/main/docs/rtc/signaling.md)
+- [What is and is not tested](https://github.com/atulsinghhhh/Raven/blob/main/docs/rtc/test-matrix.md)
+- Runnable examples: [`video-call`](https://github.com/atulsinghhhh/Raven/tree/main/examples/video-call)
+
+## React?
+
+Use [`@ravenkash/react`](https://www.npmjs.com/package/@ravenkash/react) —
+headless hooks over this package, with optional components.
+
+## License
+
+MIT