chore: bump redis to version ^4.0.1

See also: https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md

Author: darrachequesne

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [12.x, 16.x]
 
     services:
       redis:

Readme.md

@@ -44,15 +44,37 @@ The current version is compatible with both:
 
 ## How to use
 
+Installation:
+
+```
+npm i @socket.io/redis-emitter redis
+```
+
 ### CommonJS
 
-Installation: `npm i @socket.io/redis-emitter redis`
+```js
+const { Emitter } = require("@socket.io/redis-emitter");
+const { createClient } = require("redis"); // not included, needs to be explicitly installed
+
+const redisClient = createClient();
+
+redisClient.connect().then(() => {
+  const io = new Emitter(redisClient);
+
+  setInterval(() => {
+    io.emit("time", new Date);
+  }, 5000);
+})
+```
+
+With `redis@3`, calling `connect()` is not needed:
 
 ```js
 const { Emitter } = require("@socket.io/redis-emitter");
 const { createClient } = require("redis"); // not included, needs to be explicitly installed
 
 const redisClient = createClient();
+
 const io = new Emitter(redisClient);
 
 setInterval(() => {
@@ -62,18 +84,19 @@ setInterval(() => {
 
 ### TypeScript
 
-Installation: `npm i @socket.io/redis-emitter redis @types/redis`
-
 ```ts
 import { Emitter } from "@socket.io/redis-emitter";
 import { createClient } from "redis";
 
 const redisClient = createClient();
-const io = new Emitter(redisClient);
 
-setInterval(() => {
-  io.emit("time", new Date);
-}, 5000);
+redisClient.connect().then(() => {
+  const io = new Emitter(redisClient);
+
+  setInterval(() => {
+    io.emit("time", new Date);
+  }, 5000);
+});
 ```
 
 With typed events:
@@ -87,9 +110,12 @@ interface Events {
 }
 
 const redisClient = createClient();
-const io = new Emitter<Events>(redisClient);
 
-io.emit("basicEmit", 1, "2", [3]);
+redisClient.connect().then(() => {
+  const io = new Emitter<Events>(redisClient);
+
+  io.emit("basicEmit", 1, "2", [3]);
+});
 ```
 
 ## Emit cheatsheet