From 8fd504689ccc3a522df310cb424898cd9ae8575e Mon Sep 17 00:00:00 2001 From: James Turk Date: Thu, 19 Nov 2020 15:30:49 -0500 Subject: [PATCH] fix examples without zone --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index b82e543..46628bc 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Then to apply limiting, you'll call the `check_limit` function, which takes thre Example call: ``` -limiter.check_limit(zone="api", key="1234", tier_name="bronze") +limiter.check_limit(key="1234", tier_name="bronze") ``` This call will return without any error if the call is deemed allowed. @@ -56,7 +56,6 @@ If multiple limits were exceeded it will return the shortest limit violated. Your `RateLimiter` instance also has a method named `get_usage_since`, which takes four parameters: -* `zone` - Which usage zone you're requesting usage information for. * `key` - Which key you're requesting usage information for. * `start` - Date that you'd like usage since, as a `datetime.date` object. * `end` - Optional end date if you'd only like usage within a certain window, otherwise the current day is used.