github/peerjs-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme and changelog

Browse Source
This commit is contained in:
afrokick 2019-12-15 14:33:42 +03:00
parent 37ee973e55
commit 8757815da9
2 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -29,7 +29,7 @@ $> peerjs --port 9000 --key peerjs --path /myapp
Or, create a custom server: Or, create a custom server:
```javascript ```javascript
const PeerServer = require('peer').PeerServer; const { PeerServer } = require('peer');
const server = PeerServer({port: 9000, path: '/myapp'}); const server = PeerServer({port: 9000, path: '/myapp'});
``` ```
@ -45,7 +45,7 @@ Using HTTPS: Simply pass in PEM-encoded certificate and key.
```javascript ```javascript
const fs = require('fs'); const fs = require('fs');
const PeerServer = require('peer').PeerServer; const { PeerServer } = require('peer');
const server = PeerServer({ const server = PeerServer({
port: 9000, port: 9000,
@ -64,7 +64,7 @@ The option is passed verbatim to the
if it is truthy. if it is truthy.
```javascript ```javascript
const PeerServer = require('peer').PeerServer; const { PeerServer } = require('peer');
const server = PeerServer({port: 9000, path: '/myapp', proxied: true}); const server = PeerServer({port: 9000, path: '/myapp', proxied: true});
``` ```
@ -73,7 +73,7 @@ const server = PeerServer({port: 9000, path: '/myapp', proxied: true});
```javascript ```javascript
const express = require('express'); const express = require('express');
const app = express(); const app = express();
const ExpressPeerServer = require('peer').ExpressPeerServer; const { ExpressPeerServer } = require('peer');
app.get('/', (req, res, next) => { res.send('Hello world!'); }); app.get('/', (req, res, next) => { res.send('Hello world!'); });
@ -138,7 +138,7 @@ This will start a peerjs server on port 9000 exposed on port 9000.
## Problems? ## Problems?
Discuss PeerJS on our Google Group: Discuss PeerJS on our Telegram chat:
https://groups.google.com/forum/?fromgroups#!forum/peerjs https://t.me/joinchat/ENhPuhTvhm8WlIxTjQf7Og
Please post any bugs as a Github issue. Please post any bugs as a Github issue.

6
changelog.md
View File

@ -2,8 +2,10 @@
### vNEXT 0.3.0 ### vNEXT 0.3.0
* refactoring (add ESLint, split code into small unit) Thanks to @d07RiV @zhou-yg * Convert project to TypeScript 3.7.3.
* update deps * Use UUID when generate client id - #152
* Refactoring (add ESLint, split code into small unit) Thanks to @d07RiV @zhou-yg
* Update deps.
### 0.2.6 ### 0.2.6