jpt-archive/rrl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix examples without zone

Browse Source
This commit is contained in:
James Turk 2020-11-19 15:30:49 -05:00
parent df5ee75163
commit 8fd504689c
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -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.