Skip to content

Commit e0740f0

Browse files
authored
Update README.md to avoid confusion with the original
1 parent 3e72c4a commit e0740f0

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
[<img src="https://avatars.githubusercontent.com/u/42463376" alt="React Native WebRTC" style="height: 6em;" />](https://github.com/react-native-webrtc/react-native-webrtc)
22

3-
# React-Native-WebRTC
4-
5-
[![npm version](https://img.shields.io/npm/v/react-native-webrtc)](https://www.npmjs.com/package/react-native-webrtc)
6-
[![npm downloads](https://img.shields.io/npm/dm/react-native-webrtc)](https://www.npmjs.com/package/react-native-webrtc)
3+
# React-Native-WebRTC for LiveKit
4+
https://img.shields.io/npm/v/@livekit/react-native-webrtc
5+
[![npm version](https://img.shields.io/npm/v/@livekit/react-native-webrtc)](https://www.npmjs.com/package/@livekit/react-native-webrtc)
76
[![Discourse topics](https://img.shields.io/discourse/topics?server=https%3A%2F%2Freact-native-webrtc.discourse.group%2F)](https://react-native-webrtc.discourse.group/)
87

98
A WebRTC module for React Native.
109

10+
> [!NOTE]
11+
> This is a fork of the original [react-native-webrtc](https://github.com/react-native-webrtc/react-native-webrtc) repo, with different underlying WebRTC fork.
12+
> This module is primarily to be used in conjunction with the [LiveKit React Native SDK](https://github.com/livekit/client-sdk-react-native), and shouldn't be used independently.
13+
>
14+
> Developers looking to add WebRTC without LiveKit functionality to their React Native projects should use the original module instead.
15+
1116
## Feature Overview
1217

1318
| | Android | iOS | tvOS | macOS* | Windows* | Web* | Expo* |
@@ -51,9 +56,9 @@ Software encode/decode factories have been enabled by default.
5156
Use one of the following preferred package install methods to immediately get going.
5257
Don't forget to follow platform guides below to cover any extra required steps.
5358

54-
**npm:** `npm install react-native-webrtc --save`
55-
**yarn:** `yarn add react-native-webrtc`
56-
**pnpm:** `pnpm install react-native-webrtc`
59+
**npm:** `npm install @livekit/react-native-webrtc --save`
60+
**yarn:** `yarn add @livekit/react-native-webrtc`
61+
**pnpm:** `pnpm install @livekit/react-native-webrtc`
5762

5863
## Guides
5964

0 commit comments

Comments
 (0)