Skip to content

Commit ff7106d

Browse files
committed
Updated README
1 parent 747d7b9 commit ff7106d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ On a specific session (possibly hosted on a different worker process):
253253
// Function signature: emit(sessionId, event, data, callback)
254254
socket.global.emit('localhost_9101_8000_0_47kR_u7W4LGk56rSAAAA', 'foo', eventData, callback);
255255
```
256+
^ Generally, you should avoid targeting clients explicitly - Instead, you should use a pub/sub approach.
256257

257258
Broadcast to all interested sockets/sessions (on all worker processes):
258259
```js
@@ -269,7 +270,7 @@ will receive it. SocketCluster is efficient and works more like a pub/sub system
269270
When you listen to an even on the client using socket.on(...), it will send a 'subscribe' event to the backend which
270271
may be intercepted/blocked by your middleware if appropriate.
271272

272-
On the socket (only use this one if you know what you're doing; generally, it's better to emit on a session):
273+
On the socket:
273274
```js
274275
socket.emit('foo', eventData, callback);
275276
```
@@ -379,10 +380,9 @@ wsServer.addMiddleware(wsServer.MIDDLEWARE_EVENT, function (socket, event, data,
379380

380381
## Contribute to SocketCluster
381382

382-
- Tests needed - While some of the underlying modules of SC are well tested,
383-
it would be nice to add some higher-level tests to help maintain high code quality.
384-
- Documentation - Inline source documentation is needed.
385-
- Benchmarks - More benchmarks - Particularly, it would be nice to get an idea of how many concurrent connections SocketCluster can handle on a big machine.
383+
- Security - Identify and fix any vulnerabilities.
384+
- More test cases needed.
385+
- Documentation - Inline source documentation (commenting) is needed.
386386
- Efficiency/speed - faster is better!
387387

388388
To contribute; clone this repo, then cd inside it and then run npm install to install all dependencies.

0 commit comments

Comments
 (0)