Skip to content

Commit 45ae4a3

Browse files
committed
fix(package): add descriptions for client and throttler-storage packages
1 parent 97247ba commit 45ae4a3

File tree

5 files changed

+15
-3
lines changed

5 files changed

+15
-3
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
## 0.3.1 (2025-01-10)
2+
3+
### 🩹 Fixes
4+
5+
- **readme:** fix logo image paths for npm package publishing by using absolute GitHub URLs instead of relative paths ([packages/client](packages/client/README.md), [packages/throttler-storage](packages/throttler-storage/README.md))
6+
7+
### ❤️ Thank You
8+
9+
- CSenshi
10+
111
## 0.3.0 (2025-07-25)
212

313
This was a version bump only, there were no code changes.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@ export class AppModule {}
196196

197197
| Package | Status | Description | Use Cases |
198198
|---------|--------|-------------|-----------|
199-
| [`@nestjs-redis/client`](./packages/client) |**Stable** | Flexible Redis client module supporting single/multi-connection, cluster, and sentinel modes | Caching, session storage, pub/sub, queues |
200-
| [`@nestjs-redis/throttler-storage`](./packages/throttler-storage) |**Stable** | Redis storage for NestJS Throttler with distributed rate limiting | API rate limiting, DDoS protection, quota management |
199+
| [`@nestjs-redis/client`](https://www.npmjs.com/package/@nestjs-redis/client) |**Stable** | Flexible, production-ready Redis client module for NestJS with multi-connection support, built on the modern node-redis client | Caching, session storage, pub/sub, queues |
200+
| [`@nestjs-redis/throttler-storage`](https://www.npmjs.com/package/@nestjs-redis/throttler-storage) |**Stable** | Redis storage for NestJS Throttler with distributed rate limiting | API rate limiting, DDoS protection, quota management |
201201
| `@nestjs-redis/redlock` | 🚧 **Coming Soon** | Distributed lock manager using Redis | Preventing race conditions, exclusive operations |
202202

203203
Each package is published independently with comprehensive documentation. **Click the package links above for detailed installation and usage instructions.**

packages/client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# @nestjs-redis/client
66

7-
**Flexible, production-ready Redis client module for NestJS**
7+
**Flexible, production-ready Redis client module for NestJS with multi-connection support, built on the modern node-redis client**
88

99
[![npm version](https://badge.fury.io/js/%40nestjs-redis%2Fclient.svg)](https://www.npmjs.com/package/@nestjs-redis/client)
1010
[![npm downloads](https://img.shields.io/npm/dm/@nestjs-redis/client.svg)](https://www.npmjs.com/package/@nestjs-redis/client)

packages/client/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@nestjs-redis/client",
33
"version": "0.3.0",
4+
"description": "Flexible, production-ready Redis client module for NestJS with multi-connection support, built on the modern node-redis client",
45
"homepage": "https://github.com/CSenshi/nestjs-redis/tree/main/packages/client",
56
"main": "./dist/src/index.js",
67
"module": "./dist/src/index.js",

packages/throttler-storage/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@nestjs-redis/throttler-storage",
33
"version": "0.3.0",
4+
"description": "Redis storage for NestJS Throttler enabling distributed rate limiting across multiple application instances",
45
"homepage": "https://github.com/CSenshi/nestjs-redis/tree/main/packages/throttler-storage",
56
"main": "./dist/src/index.js",
67
"module": "./dist/src/index.js",

0 commit comments

Comments
 (0)