diff --git a/website/content/middleware/rate-limiter.md b/website/content/middleware/rate-limiter.md index 9b48ff04..80233680 100644 --- a/website/content/middleware/rate-limiter.md +++ b/website/content/middleware/rate-limiter.md @@ -13,13 +13,15 @@ may not be the best option for a high number of concurrent requests or a large n ### Usage -To add a rate limit to your application simply add the `RateLimiter` middlware. +To add a rate limit to your application simply add the `RateLimiter` middleware. The example below will limit the application to 20 requests/sec using the default in-memory store: ```go e.Use(middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(20))) ``` +Note: if the provided rate is a float number, Burst will be treated as the rounded down value of the rate. + ## Custom Configuration ```go