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

Update README: Remove custom peer ID documentation

Browse Source 
🤖 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-22 23:22:58 +01:00
parent 49d3984640
commit 895e7765f9
1 changed files with 3 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -437,26 +437,16 @@ const newPeers = await client.offers.findByTopic('movie-xyz', {
### Authentication ### Authentication
#### `client.register(customPeerId?)` #### `client.register()`
Register a new peer and receive credentials. Register a new peer and receive credentials.
Generates a cryptographically random 128-bit peer ID.
```typescript ```typescript
// Auto-generate peer ID
const creds = await client.register(); const creds = await client.register();
// { peerId: 'f17c195f067255e357232e34cf0735d9', secret: '...' } // { peerId: 'f17c195f067255e357232e34cf0735d9', secret: '...' }
// Or use a custom peer ID (1-128 characters)
const customCreds = await client.register('my-custom-peer-id');
// { peerId: 'my-custom-peer-id', secret: '...' }
``` ```
**Parameters:**
- `customPeerId` (optional): Custom peer ID (1-128 characters). If not provided, a random ID will be generated.
**Notes:**
- Returns 409 Conflict if the custom peer ID is already in use
- Custom peer IDs must be non-empty and between 1-128 characters
### Topics ### Topics
#### `client.offers.getTopics(options?)` #### `client.offers.getTopics(options?)`