summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-04-02 11:28:42 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-04-02 14:20:46 -0500
commit9822e3f55c40372c44ae4d8752e99e60ab88cbd4 (patch)
tree606a0c3d41d23fc639fb71bed4afe3e096a8553d /README.md
parentddba563e19f45015b251eafe776741952451433c (diff)
downloadrequests-cache-9822e3f55c40372c44ae4d8752e99e60ab88cbd4.tar.gz
Split 'core' module into 'session' and 'patcher' modules; keep placeholder 'core' module for backwards-compatibility
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
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