docs: rework of the README

socketio · Mar 13, 2024 · 5387176 · 5387176
1 parent 111ef46
commit 5387176
Show file tree

Hide file tree

Showing 4 changed files with 1,549 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,9 @@ The `@socket.io/redis-adapter` package allows broadcasting packets between multi
   - [With the `ioredis` package](#with-the-ioredis-package)
   - [With the `ioredis` package and a Redis cluster](#with-the-ioredis-package-and-a-redis-cluster)
   - [With Redis sharded Pub/Sub](#with-redis-sharded-pubsub)
+- [Options](#options)
+  - [Default adapter](#default-adapter)
+  - [Sharded adapter](#sharded-adapter)
 - [License](#license)
 
 ## Supported features
@@ -63,7 +66,7 @@ await Promise.all([
 ]);
 
 const io = new Server({
-  adapter: createAdapter(redisClient)
+  adapter: createAdapter(pubClient, subClient)
 });
 
 io.listen(3000);
@@ -185,7 +188,7 @@ Minimum requirements:
 
 ## Options
 
-### Default Redis adapter
+### Default adapter
 
 | Name                               | Description                                                                   | Default value |
 |------------------------------------|-------------------------------------------------------------------------------|---------------|