Skip to content

Commit b11cbd7

Browse files
committed
fix badges, move alternate installation instructions to wiki, add link to example
1 parent 21e0c5a commit b11cbd7

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

readme.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<div align="center">
44

55
[![tests](https://github.com/express-rate-limit/cluster-memory-store/actions/workflows/ci.yaml/badge.svg)](https://github.com/express-rate-limit/cluster-memory-store/actions/workflows/ci.yaml)
6-
[![npm version](https://img.shields.io/npm/v/cluster-memory-store.svg)](https://npmjs.org/package/cluster-memory-store 'View this project on NPM')
7-
[![npm downloads](https://img.shields.io/npm/dm/cluster-memory-store)](https://www.npmjs.com/package/cluster-memory-store)
6+
[![npm version](https://img.shields.io/npm/v/@express-rate-limit/cluster-memory-store.svg)](https://npmjs.org/package/@express-rate-limit/cluster-memory-store 'View this project on NPM')
7+
[![npm downloads](https://img.shields.io/npm/dm/@express-rate-limit/cluster-memory-store)](https://www.npmjs.com/package/@express-rate-limit/cluster-memory-store)
88

99
A memory store for the
1010
[`express-rate-limit`](https://github.com/express-rate-limit/express-rate-limit)
@@ -15,26 +15,12 @@ middleware made for use with the
1515

1616
## Installation
1717

18-
From the npm registry:
19-
20-
```sh
21-
# Using npm
22-
> npm install @express-rate-limit/cluster-memory-store
23-
# Using yarn or pnpm
24-
> yarn/pnpm add @express-rate-limit/cluster-memory-store
25-
```
26-
27-
From Github Releases:
28-
2918
```sh
30-
# Using npm
31-
> npm install https://github.com/express-rate-limit/cluster-memory-store/releases/download/v{version}/cluster-memory-store.tgz
32-
# Using yarn or pnpm
33-
> yarn/pnpm add https://github.com/express-rate-limit/cluster-memory-store/releases/download/v{version}/cluster-memory-store.tgz
19+
npm install @express-rate-limit/cluster-memory-store
3420
```
3521

36-
Replace `{version}` with the version of the package that you want to your, e.g.:
37-
`1.0.0`.
22+
([Alternate installation methods](https://github.com/express-rate-limit/cluster-memory-store/wiki/Installation-Methods) -
23+
pnpm, yarn, Github Releases, etc.)
3824

3925
## Usage
4026

@@ -63,7 +49,8 @@ const limiter = rateLimit({
6349
app.use(limiter)
6450
```
6551

66-
See the `example/` folder for a complete, working example.
52+
See the `example/` folder for a
53+
[complete, working example](https://github.com/express-rate-limit/cluster-memory-store/tree/main/example).
6754

6855
## Configuration
6956

0 commit comments

Comments
 (0)