summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-05-08 09:14:35 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-05-08 09:14:35 -0500
commit1575a86d5bde12923e408dfab89cf35745a3f7e8 (patch)
tree997ed7ab42d828ebfdeaafda3082868401a0a105 /CONTRIBUTING.md
parent064ec511e9a754b10033d8dd90be8c85b47eb6a3 (diff)
downloadrequests-cache-1575a86d5bde12923e408dfab89cf35745a3f7e8.tar.gz
Update readthedocs links to point to stable version instead of latest
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6011389..e3f901f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,11 @@
# Contributing Guide
-## Development status
+## Development Status
While the original author no longer has time to work on requests-cache
([see note here](https://github.com/reclosedev/requests-cache/blob/master/CODESHELTER.md)),
one or more maintainers are available via [Code Shelter](https://www.codeshelter.co) to help keep
this project going.
-Maintenance will mainly focus on bugfixes, security and compatibility updates, etc.
If there is a new feature you would like to see, the best way to make that happen is to submit a PR
for it!
@@ -19,6 +18,13 @@ If you want to discuss ideas about the project in general, or if you have an iss
received a response in a timely manner, please reach out on the Code Shelter chat server, under
[projects/requests-cache](https://codeshelter.zulipchat.com/#narrow/stream/186993-projects/topic/requests-cache).
+## Pre-release Installation
+If you want to test out the latest in-development changes, you can install pre-release versions:
+```bash
+pip install --pre requests-cache
+```
+Pre-release documentation can be found here: https://requests-cache.readthedocs.io/en/latest/
+
## Dev Installation
To set up for local development: