From e22e74fb744fdf91fc17faa9b285bcd0974b8c0b Mon Sep 17 00:00:00 2001 From: Bas van den Aakster Date: Sun, 16 Nov 2025 18:03:39 +0100 Subject: [PATCH] Update README to use client.createPeer() method MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Replaced `new RondevuPeer(client.offers)` with `client.createPeer()` - Updated import to only import Rondevu (not RondevuPeer) - Updated Custom RTCConfiguration example to pass config to createPeer() - Removed rtcConfig from answer() call (should be passed to createPeer) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 80f3e6b..7017be7 100644 --- a/README.md +++ b/README.md @@ -34,14 +34,14 @@ npm install @xtr-dev/rondevu-client ### Creating an Offer (Peer A) ```typescript -import { Rondevu, RondevuPeer } from '@xtr-dev/rondevu-client'; +import { Rondevu } from '@xtr-dev/rondevu-client'; // Initialize client and register const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' }); await client.register(); // Create peer connection -const peer = new RondevuPeer(client.offers); +const peer = client.createPeer(); // Set up event listeners peer.on('state', (state) => { @@ -78,7 +78,7 @@ console.log('Share these topics with peers:', ['my-app', 'room-123']); ### Answering an Offer (Peer B) ```typescript -import { Rondevu, RondevuPeer } from '@xtr-dev/rondevu-client'; +import { Rondevu } from '@xtr-dev/rondevu-client'; // Initialize client and register const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' }); @@ -91,7 +91,7 @@ if (offers.length > 0) { const offer = offers[0]; // Create peer connection - const peer = new RondevuPeer(client.offers); + const peer = client.createPeer(); // Set up event listeners peer.on('state', (state) => { @@ -121,12 +121,7 @@ if (offers.length > 0) { // Answer the offer await peer.answer(offer.id, offer.sdp, { - topics: offer.topics, - rtcConfig: { - iceServers: [ - { urls: 'stun:stun.l.google.com:19302' } - ] - } + topics: offer.topics }); } ``` @@ -232,7 +227,7 @@ await peer.close(); ## Custom RTCConfiguration ```typescript -const peer = new RondevuPeer(client.offers, { +const peer = client.createPeer({ iceServers: [ { urls: 'stun:stun.l.google.com:19302' }, {