From 7071cdc9083e2095a817088fddcad4dc89f02568 Mon Sep 17 00:00:00 2001 From: Harish Seshadri Date: Sat, 17 Oct 2026 11:13:47 -0700 Subject: [PATCH] docs(readme): update @gainratio/browser and @gainratio/errors repository links --- README.md | 10 +++++----- tests/test_readme_contract.py | 10 +++++++++- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8451f53..d7f1f80 100644 --- a/README.md +++ b/README.md @@ -87,11 +87,11 @@ It is the bottom layer of a few related projects by the same author. [edge-proc](https://github.com/gainratio/edge-proc), also on PyPI, depends on this package: it implements the `VectorIndex` protocol with FAISS and adds shipping signed data to devices. [edge-reco](https://github.com/gainratio/edge-reco), an in-browser store search demo, uses both -in its Python backend. [@edgeproc/browser](https://github.com/hseshadr/edgeproc-browser) checks -edge-proc's signed data inside a web page and does not use this package. -[privacy-core](https://github.com/gainratio/privacy-core) only shares the `@edgeproc` npm name; -it hides personal data from AI prompts and is unrelated. The error codes match the TypeScript -package [@edgeproc/errors](https://github.com/hseshadr/errors). +in its Python backend. [@gainratio/browser](https://github.com/gainratio/edgeproc-browser) +(previously `@edgeproc/browser`) checks edge-proc's signed data inside a web page and does not +use this package. [privacy-core](https://github.com/gainratio/privacy-core) only shares the +`@edgeproc` npm name; it hides personal data from AI prompts and is unrelated. The error codes +match the TypeScript package [@gainratio/errors](https://github.com/gainratio/errors). ## What it does not do diff --git a/tests/test_readme_contract.py b/tests/test_readme_contract.py index 20ca2ce..64cd1e3 100644 --- a/tests/test_readme_contract.py +++ b/tests/test_readme_contract.py @@ -133,8 +133,16 @@ def test_should_show_real_output_in_try_it() -> None: def test_should_explain_how_it_relates_to_the_sibling_projects() -> None: - for sibling in ("edge-proc", "edge-reco", "@edgeproc/browser", "privacy-core"): + for sibling in ( + "edge-proc", + "edge-reco", + "@gainratio/browser", + "@edgeproc/browser", + "privacy-core", + "@gainratio/errors", + ): assert sibling in README, f"README does not say how it relates to {sibling}" + assert "github.com/hseshadr/" not in README def test_should_state_beta_at_the_released_version_while_pre_1_0() -> None: