Skip to content

Commit

Permalink
feat: rename the package to @socket.io/redis-emitter
Browse files Browse the repository at this point in the history
So that the relationship to Redis is clearer.

Related: #94
  • Loading branch information
darrachequesne committed Mar 17, 2021
1 parent a70db12 commit 592883e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
9 changes: 4 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down Expand Up @@ -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");
Expand All @@ -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";
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 592883e

Please sign in to comment.