From 966882fa93c35d9e258dda2186dc1881f2f846d1 Mon Sep 17 00:00:00 2001 From: Shubhrakanti Ganguly Date: Tue, 13 May 2025 23:19:47 -0700 Subject: [PATCH 1/3] init --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 15fe694f..ac79b24f 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,10 @@ SPDX-License-Identifier: Apache-2.0 Use this SDK to add realtime video, audio and data features to your Node app. By connecting to LiveKit Cloud or a self-hosted server, you can quickly build applications such as multi-modal AI, live streaming, or video calls with just a few lines of code. +### Warning + +Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues. + ## Monorepo Navigation - **Packages**: From a62a652c14222f21b56fbd6bffe6f29afdf83ae2 Mon Sep 17 00:00:00 2001 From: Shubhrakanti Ganguly Date: Tue, 13 May 2025 23:25:53 -0700 Subject: [PATCH 2/3] update the public docs --- packages/livekit-rtc/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/livekit-rtc/README.md b/packages/livekit-rtc/README.md index 4d3f4cae..a13be531 100644 --- a/packages/livekit-rtc/README.md +++ b/packages/livekit-rtc/README.md @@ -16,6 +16,9 @@ Use this SDK to add realtime video, audio and data features to your Node app. By > > We welcome and appreciate any feedback or contributions. You can create issues here or chat live with us in the #dev channel within the [LiveKit Community Slack](https://livekit.io/join-slack). +### Warning + +Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues. ## Using realtime SDK From a1c67ab9b376f3c5399a4c77148d72c3950eda21 Mon Sep 17 00:00:00 2001 From: Shubhrakanti Ganguly Date: Tue, 13 May 2025 23:27:20 -0700 Subject: [PATCH 3/3] update working --- README.md | 2 +- packages/livekit-rtc/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac79b24f..6c4c48cf 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Use this SDK to add realtime video, audio and data features to your Node app. By ### Warning -Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues. +Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues with WebRTC connectivity. ## Monorepo Navigation diff --git a/packages/livekit-rtc/README.md b/packages/livekit-rtc/README.md index a13be531..bae29633 100644 --- a/packages/livekit-rtc/README.md +++ b/packages/livekit-rtc/README.md @@ -18,7 +18,7 @@ Use this SDK to add realtime video, audio and data features to your Node app. By ### Warning -Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues. +Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues with WebRTC connectivity. ## Using realtime SDK