Merge pull request #106 from Kapcash/documentation-updates
fix#86: "Updating README.md: on express example, variable names clearer"
This commit is contained in:
commit
77779e2fba
17
README.md
17
README.md
@ -78,21 +78,28 @@ var ExpressPeerServer = require('peer').ExpressPeerServer;
|
|||||||
|
|
||||||
app.get('/', function(req, res, next) { res.send('Hello world!'); });
|
app.get('/', function(req, res, next) { res.send('Hello world!'); });
|
||||||
|
|
||||||
|
// =======
|
||||||
|
|
||||||
var server = app.listen(9000);
|
var server = app.listen(9000);
|
||||||
|
|
||||||
var options = {
|
var options = {
|
||||||
debug: true
|
debug: true
|
||||||
}
|
}
|
||||||
|
|
||||||
app.use('/api', ExpressPeerServer(server, options));
|
var peerserver = ExpressPeerServer(server, options);
|
||||||
|
|
||||||
// OR
|
app.use('/api', peerserver);
|
||||||
|
|
||||||
|
// == OR ==
|
||||||
|
|
||||||
var server = require('http').createServer(app);
|
var server = require('http').createServer(app);
|
||||||
|
var peerserver = ExpressPeerServer(server, options);
|
||||||
|
|
||||||
app.use('/peerjs', ExpressPeerServer(server, options));
|
app.use('/peerjs', peerserver);
|
||||||
|
|
||||||
server.listen(9000);
|
server.listen(9000);
|
||||||
|
|
||||||
|
// ========
|
||||||
```
|
```
|
||||||
|
|
||||||
### Events
|
### Events
|
||||||
@ -100,14 +107,14 @@ server.listen(9000);
|
|||||||
The `'connection'` event is emitted when a peer connects to the server.
|
The `'connection'` event is emitted when a peer connects to the server.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
server.on('connection', function(id) { ... });
|
peerserver.on('connection', function(id) { ... });
|
||||||
```
|
```
|
||||||
|
|
||||||
The `'disconnect'` event is emitted when a peer disconnects from the server or
|
The `'disconnect'` event is emitted when a peer disconnects from the server or
|
||||||
when the peer can no longer be reached.
|
when the peer can no longer be reached.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
server.on('disconnect', function(id) { ... });
|
peerserver.on('disconnect', function(id) { ... });
|
||||||
```
|
```
|
||||||
|
|
||||||
## Problems?
|
## Problems?
|
||||||
|
Loading…
x
Reference in New Issue
Block a user