Skip to content

Commit f2b066a

Browse files
committed
chore: Improving documentation
1 parent 3214250 commit f2b066a

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111

1212
#### Simple WebRTC video, voice, and data channels
1313

14-
This package is a more up to date version of feross's simple-peer, it uses `EventEmitter` and `Uint8Array` instead of node streams and buffers, making the module lighter and fully compatible with browser bundlers like Vite. It provides `@thaunknown/simple-peer/lite.js` which is the same peer implementation, but without MediaTrack and MediaStream handling, just pure Uint8/String data.
14+
This package is a more up-to-date version of feross's simple-peer, rewritten 100% in Typescript. It uses `EventEmitter` and `Uint8Array` instead of node streams and buffers, making the module lighter and fully compatible with browser bundlers like Vite. It provides `@thaunknown/simple-peer/lite.js` which is the same peer implementation, but without MediaTrack and MediaStream handling, just pure Uint8/String data.
15+
1516

1617
> **Breaking change:** This version no longer extends `Duplex` stream. The `pipe()` method is not available. Use `peer.on('data', ...)` and `peer.send()` / `peer.write()` instead.
1718
@@ -49,14 +50,10 @@ This package is used by [WebTorrent](https://webtorrent.io) and [many others](#w
4950
## install
5051

5152
```
52-
npm install simple-peer
53+
npm install @workadventure/simple-peer
5354
```
5455

55-
This package works in the browser with [browserify](https://browserify.org). If
56-
you do not use a bundler, you can use the `simplepeer.min.js` standalone script
57-
directly in a `<script>` tag. This exports a `SimplePeer` constructor on
58-
`window`. Wherever you see `Peer` in the examples below, substitute that with
59-
`SimplePeer`.
56+
This package works in the browser with a bundler like Vite.
6057

6158
## usage
6259

0 commit comments

Comments
 (0)