Skip to content

Commit

Permalink
Bump major version to 2.0.0 (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffersonGibin committed Apr 28, 2024
1 parent 22582f0 commit 07ee633
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [v2.0.0](https://github.com/JeffersonGibin/express-rate-limiter-core/releases/tag/v2.0.0) [2024-04-27]

### Added
- **Redis Support:** Implementation of rate limit management directly via Redis to enhance scalability and performance.
- New properties `strategyCache` and `redis` added to the `ISettings` interface.
- Refer to the [documentation](https://github.com/JeffersonGibin/express-rate-limiter-core?tab=readme-ov-file#features) for more details on how to use these properties.

### Changed
- **Custom Cache Configuration:** It is now necessary to add `strategyCache: "CUSTOM"` when using a custom cache.

### Important Notes
- **Backward Compatibility:** The changes made may affect users who are using previous versions and rely on the default in-memory cache configuration.
- Users utilizing in-memory cache will not need to make changes to their existing code.
- Users who implement custom caches will need to adjust their settings to continue functioning correctly.


## [v1.0.1](https://github.com/JeffersonGibin/express-rate-limiter-core/releases/tag/v1.0.1)

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "express-rate-limiter-core",
"author": "Jefferson Gibin",
"version": "1.0.1",
"version": "2.0.0",
"description": "Provides an easy-to-use middleware for rate-limiting requests to an Express server",
"main": "lib/index.js",
"module": "lib/index.m.js",
Expand Down

0 comments on commit 07ee633

Please sign in to comment.