@libp2p/webrtc 0.0.0 → 1.0.1
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 +8 -15
- package/dist/index.min.js +23 -18
- package/dist/proto_ts/message.d.ts.map +1 -1
- package/dist/proto_ts/message.js.map +1 -1
- package/dist/src/error.d.ts +1 -1
- package/dist/src/error.d.ts.map +1 -1
- package/dist/src/error.js +0 -1
- package/dist/src/error.js.map +1 -1
- package/dist/src/index.d.ts +1 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +0 -1
- package/dist/src/index.js.map +1 -1
- package/dist/src/maconn.d.ts +3 -3
- package/dist/src/maconn.d.ts.map +1 -1
- package/dist/src/maconn.js +0 -3
- package/dist/src/maconn.js.map +1 -1
- package/dist/src/muxer.d.ts +3 -3
- package/dist/src/muxer.d.ts.map +1 -1
- package/dist/src/muxer.js +0 -3
- package/dist/src/muxer.js.map +1 -1
- package/dist/src/options.d.ts +1 -1
- package/dist/src/options.d.ts.map +1 -1
- package/dist/src/options.js +1 -1
- package/dist/src/options.js.map +1 -1
- package/dist/src/sdp.d.ts +1 -1
- package/dist/src/sdp.d.ts.map +1 -1
- package/dist/src/sdp.js +0 -1
- package/dist/src/sdp.js.map +1 -1
- package/dist/src/stream.d.ts +2 -2
- package/dist/src/stream.d.ts.map +1 -1
- package/dist/src/stream.js +0 -2
- package/dist/src/stream.js.map +1 -1
- package/dist/src/transport.d.ts +3 -3
- package/dist/src/transport.d.ts.map +1 -1
- package/dist/src/transport.js +2 -5
- package/dist/src/transport.js.map +1 -1
- package/dist/src/util.d.ts +1 -0
- package/dist/src/util.d.ts.map +1 -1
- package/dist/src/util.js +2 -0
- package/dist/src/util.js.map +1 -1
- package/package.json +3 -5
- package/proto_ts/message.ts +1 -0
- package/src/error.ts +1 -1
- package/src/index.ts +1 -1
- package/src/maconn.ts +3 -3
- package/src/muxer.ts +3 -3
- package/src/options.ts +1 -1
- package/src/sdp.ts +1 -1
- package/src/stream.ts +2 -2
- package/src/transport.ts +5 -6
- package/src/util.ts +3 -0
- package/dist/index.min.js.map +0 -7
- package/dist/stats.json +0 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @libp2p/webrtc <!-- omit in toc -->
|
|
2
2
|
|
|
3
3
|
[](http://libp2p.io/)
|
|
4
4
|
[](https://discuss.libp2p.io)
|
|
@@ -16,29 +16,28 @@
|
|
|
16
16
|
- [Interfaces](#interfaces)
|
|
17
17
|
- [Transport](#transport)
|
|
18
18
|
- [Connection](#connection)
|
|
19
|
-
- [
|
|
19
|
+
- [Development](#development)
|
|
20
20
|
- [Build](#build)
|
|
21
21
|
- [Protocol Buffers](#protocol-buffers)
|
|
22
22
|
- [Test](#test)
|
|
23
23
|
- [Lint](#lint)
|
|
24
24
|
- [Clean](#clean)
|
|
25
25
|
- [Check Dependencies](#check-dependencies)
|
|
26
|
-
- [Build a Release](#build-a-release)
|
|
27
26
|
- [License](#license)
|
|
28
|
-
- [Contribute](#contribute
|
|
27
|
+
- [Contribute](#contribute)
|
|
29
28
|
|
|
30
29
|
## Install
|
|
31
30
|
|
|
32
31
|
```console
|
|
33
|
-
$ npm i
|
|
32
|
+
$ npm i @libp2p/webrtc
|
|
34
33
|
```
|
|
35
34
|
|
|
36
35
|
### Browser `<script>` tag
|
|
37
36
|
|
|
38
|
-
Loading this module through a script tag will make it's exports available as `
|
|
37
|
+
Loading this module through a script tag will make it's exports available as `Libp2pWebrtc` in the global namespace.
|
|
39
38
|
|
|
40
39
|
```html
|
|
41
|
-
<script src="https://unpkg.com/
|
|
40
|
+
<script src="https://unpkg.com/@libp2p/webrtc/dist/index.min.js"></script>
|
|
42
41
|
```
|
|
43
42
|
|
|
44
43
|
## Usage
|
|
@@ -115,7 +114,7 @@ interface MultiaddrConnection extends Duplex<Uint8Array> {
|
|
|
115
114
|
class WebRTCMultiaddrConnection implements MultiaddrConnection { }
|
|
116
115
|
```
|
|
117
116
|
|
|
118
|
-
##
|
|
117
|
+
## Development
|
|
119
118
|
|
|
120
119
|
Contributions are welcome! The libp2p implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
|
|
121
120
|
|
|
@@ -152,7 +151,7 @@ To run all tests:
|
|
|
152
151
|
npm test
|
|
153
152
|
```
|
|
154
153
|
|
|
155
|
-
To run tests for
|
|
154
|
+
To run tests for Chrome only:
|
|
156
155
|
|
|
157
156
|
```shell
|
|
158
157
|
npm run test:chrome
|
|
@@ -192,12 +191,6 @@ npm run clean
|
|
|
192
191
|
npm run deps-check
|
|
193
192
|
```
|
|
194
193
|
|
|
195
|
-
### Build a Release
|
|
196
|
-
|
|
197
|
-
```shell
|
|
198
|
-
npm run release
|
|
199
|
-
```
|
|
200
|
-
|
|
201
194
|
## License
|
|
202
195
|
|
|
203
196
|
Licensed under either of
|