xtr.dev/rondevu-client
1
0
Fork 0
mirror of https://github.com/xtr-dev/rondevu-client.git synced 2025-12-10 10:53:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README to use client.createPeer() method

Browse Source 
- 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 <noreply@anthropic.com>
This commit is contained in:
Bas van den Aakster
2025-11-16 18:03:39 +01:00
parent 135eda73cf
commit e22e74fb74
1 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -34,14 +34,14 @@ npm install @xtr-dev/rondevu-client
### Creating an Offer (Peer A) ### Creating an Offer (Peer A)
```typescript ```typescript
import { Rondevu, RondevuPeer } from '@xtr-dev/rondevu-client'; import { Rondevu } from '@xtr-dev/rondevu-client';
// Initialize client and register // Initialize client and register
const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' }); const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' });
await client.register(); await client.register();
// Create peer connection // Create peer connection
const peer = new RondevuPeer(client.offers); const peer = client.createPeer();
// Set up event listeners // Set up event listeners
peer.on('state', (state) => { peer.on('state', (state) => {
@@ -78,7 +78,7 @@ console.log('Share these topics with peers:', ['my-app', 'room-123']);
### Answering an Offer (Peer B) ### Answering an Offer (Peer B)
```typescript ```typescript
import { Rondevu, RondevuPeer } from '@xtr-dev/rondevu-client'; import { Rondevu } from '@xtr-dev/rondevu-client';
// Initialize client and register // Initialize client and register
const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' }); const client = new Rondevu({ baseUrl: 'https://api.ronde.vu' });
@@ -91,7 +91,7 @@ if (offers.length > 0) {
const offer = offers[0]; const offer = offers[0];
// Create peer connection // Create peer connection
const peer = new RondevuPeer(client.offers); const peer = client.createPeer();
// Set up event listeners // Set up event listeners
peer.on('state', (state) => { peer.on('state', (state) => {
@@ -121,12 +121,7 @@ if (offers.length > 0) {
// Answer the offer // Answer the offer
await peer.answer(offer.id, offer.sdp, { await peer.answer(offer.id, offer.sdp, {
topics: offer.topics, topics: offer.topics
rtcConfig: {
iceServers: [
{ urls: 'stun:stun.l.google.com:19302' }
]
}
}); });
} }
``` ```
@@ -232,7 +227,7 @@ await peer.close();
## Custom RTCConfiguration ## Custom RTCConfiguration
```typescript ```typescript
const peer = new RondevuPeer(client.offers, { const peer = client.createPeer({
iceServers: [ iceServers: [
{ urls: 'stun:stun.l.google.com:19302' }, { urls: 'stun:stun.l.google.com:19302' },
{ {