Skip to content

Commit 592883e

Browse files
feat: rename the package to @socket.io/redis-emitter
So that the relationship to Redis is clearer. Related: #94
1 parent a70db12 commit 592883e

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

Readme.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11

2-
# socket.io-emitter
2+
# The Socket.IO Redis emitter
33

44
[![Build Status](https://github.com/socketio/socket.io-emitter/workflows/CI/badge.svg)](https://github.com/socketio/socket.io-emitter/actions)
55
[![NPM version](https://badge.fury.io/js/socket.io-emitter.svg)](http://badge.fury.io/js/socket.io-emitter)
66

7-
`socket.io-emitter` allows you to communicate with Socket.IO servers
8-
easily from another Node.js process (server side).
7+
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).
98

109
![Emitter diagram](./assets/emitter.png)
1110

@@ -46,7 +45,7 @@ The current version is compatible with both:
4645

4746
### CommonJS
4847

49-
Installation: `npm i socket.io-emitter redis`
48+
Installation: `npm i @socket.io/redis-emitter redis`
5049

5150
```js
5251
const { Emitter } = require("socket.io-emitter");
@@ -62,7 +61,7 @@ setInterval(() => {
6261

6362
### TypeScript
6463

65-
Installation: `npm i socket.io-emitter redis @types/redis`
64+
Installation: `npm i @socket.io/redis-emitter redis @types/redis`
6665

6766
```ts
6867
import { Emitter } from "socket.io-emitter";

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "socket.io-emitter",
2+
"name": "@socket.io/redis-emitter",
33
"version": "3.2.0",
4-
"description": "",
4+
"description": "The Socket.IO Redis emitter, allowing to communicate with a group of Socket.IO servers from another Node.js process",
55
"license": "MIT",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)