diff --git a/CHANGELOG.md b/CHANGELOG.md index 22bc02c..24f34a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,8 +21,8 @@ #### Examples -- Added a new example that demonstrates how to use the new ``RateLimiter`` - class (examples/rate_limit.py). +- Added an example that demonstrates how to use the new ``RateLimiter`` class + (examples/rate_limit.py). ### v0.5.0 (2020-07-14) diff --git a/README.md b/README.md index 51a83ba..76bb222 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ fileserver configuration: --index-file FILE If a directory contains a file with this name, that file will be served instead of auto-generating an index page (default: index.gmi) --default-lang DEFAULT_LANG - A lang parameter that will be indicated in the response meta + A lang parameter that will be used for all text/gemini responses (default: None) --rate-limit RATE_LIMIT Enable IP rate limiting, e.g. '60/5m' (60 requests per 5 minutes) diff --git a/examples/rate_limit.py b/examples/rate_limit.py index 09e1146..d2c1c49 100644 --- a/examples/rate_limit.py +++ b/examples/rate_limit.py @@ -4,7 +4,7 @@ This example shows how you can implement rate limiting on a per-endpoint basis. """ from jetforce import GeminiServer, JetforceApplication, RateLimiter, Response, Status -# Apply a global rate limiter that will be applied to all requests +# Setup a global rate limiter that will be applied to all requests global_rate_limiter = RateLimiter("100/m") app = JetforceApplication(rate_limiter=global_rate_limiter) diff --git a/jetforce/__main__.py b/jetforce/__main__.py index 7fea58c..1c1e775 100644 --- a/jetforce/__main__.py +++ b/jetforce/__main__.py @@ -94,7 +94,7 @@ group.add_argument( ) group.add_argument( "--default-lang", - help="A lang parameter that will be indicated in the response meta", + help="A lang parameter that will be used for all text/gemini responses", default=None, dest="default_lang", )