From e505cebaed7588922b14512250e921c4dab00906 Mon Sep 17 00:00:00 2001 From: Changolaxtra Date: Thu, 14 Dec 2023 15:00:23 -0600 Subject: [PATCH] fix: isUnlimited note added --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bcb733a..b28143d 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,11 @@ public class ApiApplication { The library default policy can be overridden by adding the below configuration to the `application.yaml` or `application.properties` file. -The default policy reads the `X-API-Key`, the **API Key** is `blank` and _only one request can be +The default policy reads the `X-API-Key` header in the HTTP Request, the **API Key** is `blank` and _only one request can be processed by minute_. +**Note**: If `isUnlimited` is set as `true`, it means that all the request for that API Key will be processed and the other parameters will be ignored. + ````yaml rate-limiter: apiKey-header-name: "X-API-Key" @@ -51,6 +53,9 @@ This library allows to create more **API Key Policies**, by creating the model a - Example of creating and adding one policy: +**Note**: If `isUnlimited` is set as `true`, it means that all the request for that API Key will be processed and the other parameters will be ignored. + + ````java import com.changolaxtra.cloud.ratelimiter.core.PlanLimitBucket; import com.changolaxtra.cloud.ratelimiter.core.policy.RateLimitPolicy;