From 4483502f5fdbd87e47886f1f35848c85c1194bb0 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Fri, 15 Mar 2024 16:54:31 +0100 Subject: [PATCH] Improved README --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58aa73a..9ca3daf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # Requests utilities -A set of small utilities that attempts to standardize and ease the experience -of working with `requests_cache` and `requests_ratelimiter`. +Utility for standarized usage of [`requests_cache`](https://requests-cache.readthedocs.io) and [`requests_ratelimiter`](https://github.com/JWCook/requests-ratelimiter) in a modular fashion across different libraries. + +The intention is that a libraries can automatically setup ratelimiting for +their specific use cases, as the library most likely has a better +understanding of the ratelimiting and caching behaviour of their associated websites than the user has.