Skip to content

Commit 0386cc0

Browse files
authored
Update README.md to reflect algorithm used (#64)
* Update README.md to reflect algorithm used Signed-off-by: Ben Bangert <100193+bbangert@users.noreply.github.com> * Fix other token bucket reference Signed-off-by: Ben Bangert <100193+bbangert@users.noreply.github.com> --------- Signed-off-by: Ben Bangert <100193+bbangert@users.noreply.github.com>
1 parent e9c74b0 commit 0386cc0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

valkeylimiter/README.md

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

22
# valkeylimiter
33

4-
This module provides an interface for token bucket rate limiting with precise control over limits and time windows. Inspired by GitHub's approach to scaling their API with a sharded, replicated rate limiter in Valkey ([github.blog](https://github.blog/engineering/infrastructure/how-we-scaled-github-api-sharded-replicated-rate-limiter-redis/)).
4+
This module provides an interface for fixed window rate limiting with precise control over limits and time windows. Inspired by GitHub's approach to scaling their API with a sharded, replicated rate limiter in Valkey ([github.blog](https://github.blog/engineering/infrastructure/how-we-scaled-github-api-sharded-replicated-rate-limiter-redis/)).
55

66
## Features
77

8-
- **Token Bucket Algorithm**: Implements a token bucket algorithm to control the number of actions (e.g., API requests) a user can perform within a specified time window.
8+
- **Fixed Window Algorithm**: Implements a fixed window algorithm to control the number of actions (e.g., API requests) a user can perform within a specified time window.
99
- **Customizable Limits**: Allows configuration of request limits and time windows to suit various application requirements.
1010
- **Distributed Rate Limiting**: Leverages Valkey to maintain rate limit counters, ensuring consistency across distributed environments.
1111
- **Reset Information**: Provides `ResetAtMs` timestamps to inform clients when they can retry requests.

0 commit comments

Comments
 (0)