@libp2p/webrtc 6.1.0 → 7.0.0-6d888970e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/dist/index.min.js +2 -2
- package/dist/index.min.js.map +3 -3
- package/dist/src/index.d.ts +13 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +13 -0
- package/dist/src/index.js.map +1 -1
- package/package.json +18 -10
- package/src/index.ts +13 -0
- package/dist/typedoc-urls.json +0 -14
package/README.md
CHANGED
|
@@ -30,6 +30,19 @@ A [libp2p transport](https://libp2p.io/docs/transports-overview/) based on [WebR
|
|
|
30
30
|
|
|
31
31
|
There are two transports exposed by this module, [webRTC](https://github.com/libp2p/specs/blob/master/webrtc/webrtc.md) and [webRTCDirect](https://github.com/libp2p/specs/blob/master/webrtc/webrtc-direct.md).
|
|
32
32
|
|
|
33
|
+
## React Native installation
|
|
34
|
+
|
|
35
|
+
React Native applications must install the optional `react-native-webrtc`
|
|
36
|
+
peer dependency explicitly:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npm install @libp2p/webrtc react-native-webrtc@^124.0.6
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Follow the [react-native-webrtc installation instructions](https://github.com/react-native-webrtc/react-native-webrtc#getting-started)
|
|
43
|
+
to configure the native module. Node.js and browser applications do not
|
|
44
|
+
need this dependency.
|
|
45
|
+
|
|
33
46
|
## WebRTC vs WebRTC Direct
|
|
34
47
|
|
|
35
48
|
The connection establishment phase of WebRTC involves a handshake using [SDP](https://en.wikipedia.org/wiki/Session_Description_Protocol) during which two peers will exchange information such as open ports, network addresses and required capabilities.
|