From 592883e9d85063411ffde760e0cdef10245e2573 Mon Sep 17 00:00:00 2001
From: Damien Arrachequesne <damien.arrachequesne@gmail.com>
Date: Wed, 17 Mar 2021 23:44:47 +0100
Subject: [PATCH] feat: rename the package to @socket.io/redis-emitter

So that the relationship to Redis is clearer.

Related: https://github.com/socketio/socket.io-emitter/issues/94
---
 Readme.md         | 9 ++++-----
 package-lock.json | 2 +-
 package.json      | 4 ++--
 3 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/Readme.md b/Readme.md
index 2b08222..82e2910 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,11 +1,10 @@
 
-# socket.io-emitter
+# The Socket.IO Redis emitter
 
 [![Build Status](https://github.com/socketio/socket.io-emitter/workflows/CI/badge.svg)](https://github.com/socketio/socket.io-emitter/actions)
 [![NPM version](https://badge.fury.io/js/socket.io-emitter.svg)](http://badge.fury.io/js/socket.io-emitter)
 
-`socket.io-emitter` allows you to communicate with Socket.IO servers
-easily from another Node.js process (server side).
+The `@socket.io/redis-emitter` package allows you to easily communicate with a group of Socket.IO servers from another Node.js process (server-side).
 
 ![Emitter diagram](./assets/emitter.png)
 
@@ -46,7 +45,7 @@ The current version is compatible with both:
 
 ### CommonJS
 
-Installation: `npm i socket.io-emitter redis`
+Installation: `npm i @socket.io/redis-emitter redis`
 
 ```js
 const { Emitter } = require("socket.io-emitter");
@@ -62,7 +61,7 @@ setInterval(() => {
 
 ### TypeScript
 
-Installation: `npm i socket.io-emitter redis @types/redis`
+Installation: `npm i @socket.io/redis-emitter redis @types/redis`
 
 ```ts
 import { Emitter } from "socket.io-emitter";
diff --git a/package-lock.json b/package-lock.json
index d0e78f9..503b80a 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,5 +1,5 @@
 {
-  "name": "socket.io-emitter",
+  "name": "@socket.io/redis-emitter",
   "version": "3.2.0",
   "lockfileVersion": 1,
   "requires": true,
diff --git a/package.json b/package.json
index ee8596d..61ae0b7 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "socket.io-emitter",
+  "name": "@socket.io/redis-emitter",
   "version": "3.2.0",
-  "description": "",
+  "description": "The Socket.IO Redis emitter, allowing to communicate with a group of Socket.IO servers from another Node.js process",
   "license": "MIT",
   "repository": {
     "type": "git",