chore: added warning in readme

rhinobase · Mar 20, 2024 · 101e23d · 101e23d
1 parent 0937ad2
commit 101e23d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,9 @@
 Rate limiting middleware for [Hono](https://hono.dev/). Use to
 limit repeated requests to public APIs and/or endpoints such as password reset.
 
+> [!WARNING]  
+> The `keyGenerator` function is currently under construction and needs to be defined for `hono-rate-limiter` to work properly in your environment. Please ensure that you define the `keyGenerator` function according to the documentation before using the library.
+
 ## Usage
 
 ```ts