@tiktool/live 2.4.9 → 2.5.1

package/README.md

@@ -1,5 +1,3 @@
-<div align="center">
-
 # @tiktool/live
 
 ### Connect to any TikTok LIVE stream in 4 lines of code.
@@ -13,8 +11,6 @@ Real-time chat, gifts, viewers, battles, follows & 18+ event types from any TikT
 
 [Quick Start](#-quick-start) · [Events](#-events) · [API](#-api-reference) · [Rate Limits](#-rate-limits) · [Get API Key](https://tik.tools)
 
-</div>
-
 ---
 
 ## ⚡ Quick Start
@@ -58,7 +54,7 @@ await live.connect();
                               with our server                YOUR IP
 ```
 
-- Your app connects directly to TikTok from your IP address
+- Your app connects directly to TikTok — from your IP or through a proxy
 - The sign server only generates cryptographic signatures (requires API key)
 - TikTok never sees the sign server
 - Built-in protobuf parser, no external dependencies
@@ -123,6 +119,7 @@ live.on('event', (event) => {
 | `uniqueId` | `string` | — | TikTok username (without @) |
 | `apiKey` | `string` | — | **Required.** API key from [tik.tools](https://tik.tools) |
 | `signServerUrl` | `string` | `https://api.tik.tools` | Sign server URL |
+| `proxyUrl` | `string` | — | HTTP proxy for all connections (`http://user:pass@host:port`) |
 | `autoReconnect` | `boolean` | `true` | Auto-reconnect on disconnect |
 | `maxReconnectAttempts` | `number` | `5` | Max reconnect attempts |
 | `heartbeatInterval` | `number` | `10000` | Heartbeat interval (ms) |
@@ -257,6 +254,29 @@ console.log('Forwarding events to ws://localhost:8080');
 
 ---
 
+## 🌐 Proxy Support
+
+Route all connections through an HTTP proxy. Works with any HTTPS proxy provider (residential, datacenter, etc.).
+
+```typescript
+import { TikTokLive } from '@tiktool/live';
+
+const live = new TikTokLive({
+    uniqueId: 'streamer_name',
+    apiKey: 'YOUR_API_KEY',
+    proxyUrl: 'http://user:pass@proxy.example.com:1234',
+});
+
+await live.connect(); // Both HTTP and WebSocket go through the proxy
+```
+
+Both the initial page request and the WebSocket connection are routed through the proxy. This is useful for:
+- Running multiple concurrent connections from different IPs
+- Avoiding rate limits
+- Geo-targeting specific regions
+
+---
+
 ## TypeScript
 
 Full TypeScript support with type inference: