Skip to content

Commit 34a053d

Browse files
committed
Improved README
1 parent cc43bad commit 34a053d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ SocketCluster
55

66
**See bottom of page for benchmark tests.**
77

8+
### Introduction
9+
810
SocketCluster is a fast, highly scalable HTTP + WebSocket (engine.io) server which lets you build multi-process
911
realtime systems/apps that make use of all CPU cores on a machine/instance.
1012
It removes the limitations of having to run your Node.js server as a single thread.
@@ -20,6 +22,12 @@ SocketCluster was designed to be lightweight and its realtime API is almost iden
2022

2123
Follow the project on Twitter: https://twitter.com/SocketCluster
2224

25+
### Recent changes
26+
27+
v0.9.42 - Major efficiency improvement - Now using UNIX sockets instead of TCP sockets for IPC. Uses named pipes on Windows.
28+
This change affected the API. The workers and stores start options are now just integers instead of arrays of port numbers.
29+
Also note that the balancerCount option was renamed to balancers.
30+
2331
### Memory leak profile
2432

2533
SocketCluster has been tested for memory leaks.
@@ -29,6 +37,7 @@ No memory leaks were detected when using the latest Node.js version.
2937
Note that leaks were found when using Node.js versions below v0.10.22 - This is probably the Node.js 'Walmart' memory leak - Not a SocketCluster issue.
3038

3139
### Main Contributors
40+
3241
- Jonathan Gros-Dubois
3342
- Nelson Zheng
3443
- Gabriel Muller

0 commit comments

Comments
 (0)