|
@@ -1,22 +1,29 @@
|
|
|
# Node PeerJS
|
|
|
|
|
|
+[](https://www.npmjs.org/package/peerjs-on-nodejs)
|
|
|
+
|
|
|
A port of the [PeerJS library](https://github.com/peers/peerjs) which currently only works on browsers. It uses the `wrtc` node module to provide webrtc functionality and fixes various compatibility issues with NodeJS.
|
|
|
|
|
|
## Install
|
|
|
|
|
|
```
|
|
|
-npm i --save node-peerjs
|
|
|
+npm i --save peerjs-on-node
|
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
-Just refer to the PeerJS documentation for a more detailed description of how the module works. You can also take a look at the `examples/` directory in this repo to see a small example using `node-peerjs`
|
|
|
+Just refer to the PeerJS documentation for a more detailed description of how the module works. You can also take a look at the `examples/` directory in this repo to see a small example using `peerjs-on-node`
|
|
|
+- Import the module like this
|
|
|
+
|
|
|
+ ```
|
|
|
+ const Peer = require('peerjs-on-node').Peer;
|
|
|
+ ```
|
|
|
|
|
|
## Build history
|
|
|
|
|
|
#### v1.0.0
|
|
|
|
|
|
-- Based on commit [0645dc3ddd51cbc1649ed13af56d9b66958fd62b](https://github.com/peers/peerjs/commit/0645dc3ddd51cbc1649ed13af56d9b66958fd62b) of PeerJS
|
|
|
+- Based on commit [0645dc3](https://github.com/peers/peerjs/commit/0645dc3ddd51cbc1649ed13af56d9b66958fd62b) of PeerJS
|
|
|
- First release version that tries to make most of the peerJS functionality work on NodeJS
|
|
|
-- See file `patch.diff` for all the modification made to the base PeerJS code and get it running on NodeJS
|
|
|
+- See file `patch/patch.diff` for all the modification made to the base PeerJS code and get it running on NodeJS
|
|
|
- PeerJS code not included in this repo
|