From 254826f86cb85ab9513df14eeb671e5930a4579d Mon Sep 17 00:00:00 2001 From: disqualifier Date: Mon, 29 Jun 2026 18:13:53 -0400 Subject: [PATCH] docs: pin install line to release, note unpinned-latest option Signed-off-by: disqualifier --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d6f5584..c655a06 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,19 @@ and storage-agnostic. `requirements.txt`: ``` -envelope_crypto @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_crypto.git +envelope_crypto @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_crypto.git@v0.1.3 ``` Direct: ```bash -pip install "envelope_crypto @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_crypto.git" +pip install "envelope_crypto @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_crypto.git@v0.1.3" ``` Requires `cryptography` (pulled transitively). +Drop the `@v0.1.3` suffix from the line above to install the latest unpinned. + ## First-time setup Run once, ever, to create the data key and authorize the first system. You need an @@ -152,4 +154,4 @@ The lib never touches a database; only the caller's storage layer differs. ## 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.