From 130a1117e924de615e0ba2a71a5daca60ef95ea8 Mon Sep 17 00:00:00 2001 From: Florent CATIAU-TRISTANT Date: Tue, 2 Jan 2018 19:47:40 +0100 Subject: [PATCH] Updating README.md: on express example, variable names clearer --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index efe2ff1..5a40dc3 100644 --- a/README.md +++ b/README.md @@ -78,21 +78,28 @@ var ExpressPeerServer = require('peer').ExpressPeerServer; app.get('/', function(req, res, next) { res.send('Hello world!'); }); +// ======= + var server = app.listen(9000); var options = { 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 peerserver = ExpressPeerServer(server, options); -app.use('/peerjs', ExpressPeerServer(server, options)); +app.use('/peerjs', peerserver); server.listen(9000); + +// ======== ``` ### Events @@ -100,14 +107,14 @@ server.listen(9000); The `'connection'` event is emitted when a peer connects to the server. ```javascript -server.on('connection', function(id) { ... }); +peerserver.on('connection', function(id) { ... }); ``` The `'disconnect'` event is emitted when a peer disconnects from the server or when the peer can no longer be reached. ```javascript -server.on('disconnect', function(id) { ... }); +peerserver.on('disconnect', function(id) { ... }); ``` ## Problems?