docs: add diagrams to explain how it works

socketio · Jan 25, 2021 · a367d1b · a367d1b
1 parent e55edb9
commit a367d1b
Show file tree

Hide file tree

Showing 5 changed files with 2,110 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@ A simple and performant way to use [Socket.IO](https://socket.io/) within a [clu
 
 Unlike other packages like [sticky-session](https://github.com/indutny/sticky-session), the routing is based on the session ID (the `sid` query parameter).
 
+![Cluster diagram](./assets/socket.io-cluster.png)
+
 See also:
 
 - [sticky-session](https://github.com/indutny/sticky-session) (routing based on `connection.remoteAddress`)
@@ -85,6 +87,8 @@ const socket = io({
 
 - the [Redis adapter](https://github.com/socketio/socket.io-redis) (or any compatible adapter) is still needed when broadcasting packets
 
+![Cluster diagram with Redis](./assets/socket.io-cluster-redis.png)
+
 ## License
 
 MIT