From 215471514531a3d09682485a9e172cd533aaaa1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20N=C3=A9grier?= Date: Mon, 29 Dec 2025 16:12:36 +0100 Subject: [PATCH] chore: Improving documentation --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4951bfb6..7c24d025 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ #### Simple WebRTC video, voice, and data channels -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. +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. + > **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. @@ -49,14 +50,10 @@ This package is used by [WebTorrent](https://webtorrent.io) and [many others](#w ## install ``` -npm install simple-peer +npm install @workadventure/simple-peer ``` -This package works in the browser with [browserify](https://browserify.org). If -you do not use a bundler, you can use the `simplepeer.min.js` standalone script -directly in a `