Skip to content

fix: Update README.md #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: Update README.md #224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The documentation is on [read the docs](https://slowapi.readthedocs.io/en/latest
`slowapi` is available from [pypi](https://pypi.org/project/slowapi/) so you can install it as usual:

```
$ pip install slowapi
pip install slowapi
```

# Features
Expand All @@ -34,17 +34,17 @@ Supported now:
* The `request` argument must be explicitly passed to your endpoint, or `slowapi` won't be able to hook into it. In other words, write:

```python
@limiter.limit("5/minute")
async def myendpoint(request: Request)
pass
@limiter.limit("5/minute")
async def myendpoint(request: Request)
pass
```

and not:

```python
@limiter.limit("5/minute")
async def myendpoint()
pass
@limiter.limit("5/minute")
async def myendpoint()
pass
```

* `websocket` endpoints are not supported yet.
Expand All @@ -56,12 +56,12 @@ PRs are more than welcome! Please include tests for your changes :)
The package uses [poetry](https://python-poetry.org) to manage dependencies. To setup your dev env:

```bash
$ poetry install
poetry install
```

To run the tests:
```bash
$ pytest
pytest
```

# Credits
Expand Down