add README.md

badrazizi · Dec 21, 2021 · f15b203 · f15b203
1 parent 03b8e2f
commit f15b203
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+
+# Eclipse Vert.x Rate Limiter
+
+configurable in-memory rate limiter
+
+```kotlin
+val clients: Storage = Storage.newInstance()
+val throttling: ThrottleImpl = Throttl
+        .getThrottling(vertx, null, clients)
+        .includeHeaders(true) // will add rate limit headers to the response.
+        .throttlingRequest(30) // requests limit.
+        .throttlingTime(60) // time limit.
+        .throttlingTimeUnit(TimeUnit.SECONDS) // time unit.
+
+val router = throttling.getRouter()
+```