From 9822e3f55c40372c44ae4d8752e99e60ab88cbd4 Mon Sep 17 00:00:00 2001 From: Jordan Cook Date: Fri, 2 Apr 2021 11:28:42 -0500 Subject: Split 'core' module into 'session' and 'patcher' modules; keep placeholder 'core' module for backwards-compatibility --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4cb531e..c97feb8 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,10 @@ pip install requests-cache ## General Usage There are two main ways of using `requests-cache`: -* **Sessions:** Use [requests_cache.CachedSession](https://requests-cache.readthedocs.io/en/latest/api.html#requests_cache.core.CachedSession) +* **Sessions:** Use [requests_cache.CachedSession](https://requests-cache.readthedocs.io/en/latest/api.html#requests_cache.session.CachedSession) in place of [requests.Session](https://requests.readthedocs.io/en/master/user/advanced/#session-objects) (recommended) * **Patching:** Globally patch `requests` using - [requests_cache.install_cache](https://requests-cache.readthedocs.io/en/latest/api.html#requests_cache.core.install_cache) + [requests_cache.install_cache](https://requests-cache.readthedocs.io/en/latest/api.html#requests_cache.patcher.install_cache) ### Sessions `CachedSession` wraps `requests.Session` with caching features, and otherwise behaves the same as a -- cgit v1.2.1