Skip to content

Commit

Permalink
fix: updated package descriptions and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MathurAditya724 committed Sep 19, 2024
1 parent 07656a0 commit 3ff121d
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/cloudflare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

</div>

This package include [`WorkersKV`](https://developers.cloudflare.com/kv/) and [Durable Object](https://developers.cloudflare.com/durable-objects/) store for the [`hono-rate-limiter`](https://github.com/rhinobase/hono-rate-limiter) middleware and `cloudflareRateLimiter` func for [Workers Rate Limiting](https://developers.cloudflare.com/workers/runtime-apis/bindings/rate-limit/) API.
This package includes [`WorkersKV`](https://developers.cloudflare.com/kv/) and [Durable Object](https://developers.cloudflare.com/durable-objects/) store for the [`hono-rate-limiter`](https://github.com/rhinobase/hono-rate-limiter) middleware and `cloudflareRateLimiter` func for [Workers Rate Limiting](https://developers.cloudflare.com/workers/runtime-apis/bindings/rate-limit/) API.

> [!NOTE]
> The `keyGenerator` function and `rateLimitBinding` bindings needs to be defined for `cloudflareRateLimiter` to work properly in your environment. Please ensure that you define the `keyGenerator` function according to the documentation before using the library.
Expand Down
1 change: 1 addition & 0 deletions packages/cloudflare/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@hono-rate-limiter/cloudflare",
"description": "Cloudflare stores and helper functions for hono-rate-limiter.",
"version": "0.1.1",
"license": "MIT",
"keywords": [
Expand Down
1 change: 1 addition & 0 deletions packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "hono-rate-limiter",
"description": "Rate limit middleware for Hono.",
"version": "0.4.0",
"license": "MIT",
"keywords": [
Expand Down
1 change: 1 addition & 0 deletions packages/redis/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@hono-rate-limiter/redis",
"description": "A serverless redis store for hono-rate-limiter.",
"version": "0.1.4",
"license": "MIT",
"keywords": [
Expand Down

0 comments on commit 3ff121d

Please sign in to comment.