python/slowapi
1
0
Fork 0
mirror of https://github.com/laurentS/slowapi.git synced 2025-08-26 13:10:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #121 from laurentS/update-readme

Browse Source
This commit is contained in:
Laurent Savaete
2023-03-02 19:25:02 +00:00
committed by GitHub
parent 2f44b553ba 9bfa87af85
commit b98ca4f820
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -2,7 +2,8 @@
A rate limiting library for Starlette and FastAPI adapted from [flask-limiter](http://github.com/alisaifee/flask-limiter).
Note: this is alpha quality code still, the API may change, and things may fall apart while you try it.
This package is used in various production setups, handling millions of requests per month, and seems to behave as expected.
There might be some API changes when changing the code to be fully `async`, but we will notify users via appropriate `semver` version changes.
The documentation is on [read the docs](https://slowapi.readthedocs.io/en/latest/).

2
docs/index.md
View File

@ -167,7 +167,7 @@ $ pytest
To release a new version:
- Update CHANGELOG.md
- Bump the version number is `pyproject.toml`
- Bump the version number in `pyproject.toml`
- `poetry build`
- `poetry publish`