Skip to content

Commit 1a0e754

Browse files
yagikotaaldas
authored andcommitted
improve doc
1 parent b81356d commit 1a0e754

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

website/content/middleware/rate-limiter.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@ may not be the best option for a high number of concurrent requests or a large n
1313

1414
### Usage
1515

16-
To add a rate limit to your application simply add the `RateLimiter` middlware.
16+
To add a rate limit to your application simply add the `RateLimiter` middleware.
1717
The example below will limit the application to 20 requests/sec using the default in-memory store:
1818

1919
```go
2020
e.Use(middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(20)))
2121
```
2222

23+
Note: if the provided rate is a float number, Burst will be treated as the rounded down value of the rate.
24+
2325
## Custom Configuration
2426

2527
```go

0 commit comments

Comments
 (0)