Update README with offer/answer terminology

- Update API documentation to reflect POST /offer, POST /answer endpoints
- Update environment variables (OFFER_TIMEOUT, VERSION)
- Clarify direct peer-to-peer connections via offer/answer exchange
- Align documentation with WebRTC standard terminology

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2025-11-12 23:29:05 +01:00
parent 28ef5eb1d1
commit cdc66ad1d7

View File

@@ -1,8 +1,8 @@
# Rondevu # Rondevu
🎯 **Simple WebRTC peer signaling and discovery** 🎯 **Simple WebRTC peer signaling**
Meet peers by topic, by peer ID, or by connection ID. Direct peer-to-peer connections via offer/answer exchange.
**Related repositories:** **Related repositories:**
- [rondevu-client](https://github.com/xtr-dev/rondevu-client) - TypeScript client library - [rondevu-client](https://github.com/xtr-dev/rondevu-client) - TypeScript client library
@@ -12,7 +12,7 @@ Meet peers by topic, by peer ID, or by connection ID.
## Rondevu Server ## Rondevu Server
HTTP signaling server for WebRTC peer discovery and connection establishment. Supports SQLite (Node.js/Docker) and Cloudflare D1 (Workers) storage backends. HTTP signaling server for WebRTC peer connection establishment. Supports SQLite (Node.js/Docker) and Cloudflare D1 (Workers) storage backends.
### Quick Start ### Quick Start
@@ -35,19 +35,20 @@ npx wrangler deploy
```bash ```bash
# Create offer # Create offer
POST /:topic/offer {"peerId":"alice","offer":"..."} POST /offer {"peerId":"alice","offer":"...","code":"my-room"}
# List sessions # Send answer/candidates
GET /:topic/sessions POST /answer {"code":"my-room","answer":"...","side":"answerer"}
# Send answer
POST /answer {"code":"...","answer":"..."}
# Poll for updates # Poll for updates
POST /poll {"code":"...","side":"offerer|answerer"} POST /poll {"code":"my-room","side":"offerer"}
```
See [API.md](./API.md) for details. # Health check with version
GET /health
# Version info
GET /
```
### Configuration ### Configuration
@@ -56,9 +57,10 @@ Environment variables:
| Variable | Default | Description | | Variable | Default | Description |
|----------|---------|-------------| |----------|---------|-------------|
| `PORT` | `3000` | Server port (Node.js/Docker) | | `PORT` | `3000` | Server port (Node.js/Docker) |
| `SESSION_TIMEOUT` | `300000` | Session timeout in milliseconds | | `OFFER_TIMEOUT` | `60000` | Offer timeout in milliseconds (1 minute) |
| `CORS_ORIGINS` | `*` | Comma-separated allowed origins | | `CORS_ORIGINS` | `*` | Comma-separated allowed origins |
| `STORAGE_PATH` | `./sessions.db` | SQLite database path (use `:memory:` for in-memory) | | `STORAGE_PATH` | `./offers.db` | SQLite database path (use `:memory:` for in-memory) |
| `VERSION` | `0.0.1` | Server version (semver) |
### License ### License