From 09e6d15e48bd5b4c837a242a054a5237b928b971 Mon Sep 17 00:00:00 2001 From: disqualifier Date: Mon, 29 Jun 2026 18:07:37 -0400 Subject: [PATCH] docs: show unpinned install line; note tag-pinning for reproducibility Signed-off-by: disqualifier --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 75a66d3..18eb9ca 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,20 @@ authorization system and the key-document schema; the crypto primitives live in ## Install ``` -envelope_authorizer @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_authorizer.git@v0.1.2 +envelope_authorizer @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_authorizer.git ``` Direct: ```bash -pip install "envelope_authorizer @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_authorizer.git@v0.1.2" +pip install "envelope_authorizer @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_authorizer.git" ``` The base install uses a local JSON file for storage (stdlib only). For shared dev→server storage, install the mongo extra: ```bash -pip install "envelope_authorizer[mongo] @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_authorizer.git@v0.1.2" +pip install "envelope_authorizer[mongo] @ git+ssh://git@git.rethinkstudios.io/rethink-public/envelope_authorizer.git" ``` Installing pulls `envelope_crypto` (and `mongo` with the extra). After install, @@ -222,5 +222,7 @@ Owned by this lib (not `envelope_crypto`): ## Versioning -Tagged `vX.Y.Z`. Pin the tag. `envelope_crypto` is pinned at `v0.1.0` in -`pyproject.toml`; to change it, edit the pin and re-test. +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. `envelope_crypto` is pinned at `v0.1.0` in `pyproject.toml`; to change it, edit +the pin and re-test.