docs: pin install line to release, note unpinned-latest option

Signed-off-by: disqualifier <dev@disqualifier.me>
This commit is contained in:
disqualifier 2026-06-29 18:13:56 -04:00
parent 6103d63b9f
commit 816c71a3f5

View File

@ -8,17 +8,19 @@ helpers for the common paths, with a raw escape hatch for everything else.
`requirements.txt`:
```
mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git
mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.2
```
Direct:
```bash
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git"
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.2"
```
Requires `motor` and `pymongo` (pulled transitively).
Drop the `@v0.1.2` suffix from the line above to install the latest unpinned.
## Usage
**Object (preferred)** — one client per process:
@ -71,4 +73,4 @@ are included.
## Versioning
Releases are tagged `vX.Y.Z`. The install line above is unpinned and tracks the latest on the default branch; append `@vX.Y.Z` to pin a specific release for reproducible installs.
Releases are tagged `vX.Y.Z`. The install line above pins a release; drop the `@vX.Y.Z` suffix to install the latest unpinned. Pin deliberately for reproducible installs.