Skip to content

docs(readme): update @gainratio/browser and @gainratio/errors repository links #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hseshadr merged 1 commit into from
Oct 17, 2026
Merged

docs(readme): update @gainratio/browser and @gainratio/errors repository links #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 9 additions & 1 deletion tests/test_readme_contract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading