summaryrefslogtreecommitdiff
path: root/docs/user_guide.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-07-20 20:52:37 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-07-20 20:52:49 -0500
commit53b7cfa379547870f4b2ce5003cd139b1b817204 (patch)
treeca225780fa5aa44e59dde3e643fdf01816a06f20 /docs/user_guide.md
parent6bf9d6f9611b20e8e270ccf3a708c223832df6e3 (diff)
downloadrequests-cache-53b7cfa379547870f4b2ce5003cd139b1b817204.tar.gz
Add some missing modules to API docs, and some additional doc formatting
Diffstat (limited to 'docs/user_guide.md')
-rw-r--r--docs/user_guide.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/user_guide.md b/docs/user_guide.md
index 68cd2a1..820d2c0 100644
--- a/docs/user_guide.md
+++ b/docs/user_guide.md
@@ -4,7 +4,12 @@ This section covers the main features of requests-cache.
## Installation
Install with pip:
```
-$ pip install requests-cache
+pip install requests-cache
+```
+
+Or with Conda, if you prefer:
+```
+conda install -c conda-forge requests-cache
```
### Requirements
@@ -12,8 +17,9 @@ $ pip install requests-cache
- You may need additional dependencies depending on which backend you want to use. To install with
extra dependencies for all supported {ref}`user_guide:cache backends`:
```
- $ pip install requests-cache\[backends\]
+ pip install requests-cache[backends]
```
+
### Optional Setup Steps
- See {ref}`security` for recommended setup steps for more secure cache serialization.
- See {ref}`Contributing Guide <contributing:dev installation>` for setup steps for local development.