Repository navigation
README: restructure like the larger decision-model repos; zh-CN README, CITATION.cff, logo, social preview - #9
Merged
Conversation
…EADME, CITATION.cff, logo and social preview Quick start and the reasons to use it come first, then one model table with a recommendation, a comparison with hosted Jev, Kev and Laya, the agent tooling, and new sections: how it works, limitations, used by and mentioned in, roadmap, citation. The identity, training-source and service-status statements move to "About the project" at the end, unchanged in substance. The mcp-name line stays. Docs only: no runtime, dependency or model-revision change. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Port the content changes of #10 (fix/audit-0.6.4) into the restructured README so that, once #10 is merged, README.md can be resolved by taking this branch's version: - Decision Index 0.3: the public board entry (2026-11-04, jev-style-2b-v4: Public 44.37, Full 34.53, Breadth 41.75; Vision 57.55 / 51.94; 0.8B v3 17.0 / 12.5) replaces the self-run wording, with one line on Public vs Full. The outdated 2B v4 banner is no longer shown. - Hosted API section: jev-style-2b-decision-v4, text only, 8,192-token context, 8,000-token inputs, no fixed per-account quota, 429 with Retry-After, 413 input_too_large vs the local 400 max_tokens_exceeded. - Install commands carry the [torch] / [mlx] extras (also in the comparison table); the bare install and the mlx-lm 0.31.3 pin are explained. - noul / choice examples (team routing, refund, phishing, topic, tool choice) in place of the urgency and frustration score examples. - Key rule, both error-body shapes, Host / Origin check, download and --verify integrity checks, guard "200 without usable answers is ask", guard numbers measured with the 0.8B v3, MCP instructions, llama.cpp download-first steps, Discussions and SECURITY.md. Review fixes: Models link and WEIGHTS badge point at the Hub profile (the v4 collection has no 0.8B); Kev's smallest download is Kev-0.8B; "Train on your own labels" is "no"; the roadmap is marked as ideas with no dates and its open items as proposals; the Hub library line names the main (PyTorch) model pages; "Used by" keeps only entries that could be checked. README.zh-CN.md gets the same changes; CITATION.cff is 0.6.4. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
README.md: this branch's version (it already carries the 0.6.4 content). CHANGELOG.md: both entries, Unreleased above 0.6.4. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs only. Nothing in the runtime, dependencies or pinned model revisions changes.
Why
The repository page is the whole product page: in the last 14 days, 95 of 99 unique visitors looked at the overview and almost nobody opened a second file. The README opened with two paragraphs of guide links and three paragraphs on identity, training sources and service status before any install command, and the reasons to use the project were 230 lines down. The highest-starred repositories in this space (jaredpalmer/kev, ollaya-dev/ollaya, NandhaKishorM/laya, nokia-applied-research/AnyJev, Valen-Team/Valen) all open with a one-line pitch, a link row, an install command and a visible result, then highlights, a model table with a recommendation, a comparison table, how it works, limitations, a roadmap and a citation.
What changes
<details>), where it fits (new comparison with hosted Jev, Kev and Laya, cells taken from their READMEs on 2026-11-03), Python / shell / curl examples, agent skills, guard, MCP, eval, recipes, cascades, backends and speed, API, how it works (new, from the model cards), limitations (new; the BANKING77 TF–IDF result and every other caveat now live here instead of inside Quick start), used by and mentioned in (vLLM Semantic Router blog, eullm, Hub library integration, awesome lists, MCP Registry), roadmap, repository layout, contributing, citation, about the project.<!-- mcp-name -->line stays (tests/test_server_json.py passes).README.zh-CN.md: a Chinese summary that points to the English README as canonical.CITATION.cff: enables GitHub's "Cite this repository" button.docs/assets/logo.svg,logo-dark.svg(the ring-and-tail mark from the site's social card) anddocs/assets/social-preview.png(the site's 1200×630 card, for Settings → Social preview; GitHub does not expose that setting through the API).To review before merging
main, as the banner and GIF already are, so they render after the merge, not in this PR's preview.Checks
pytest -q: 233 passed.uv build+twine check --strict: PASSED (the README is the PyPI long description).<picture>header and the four<details>blocks intact; every in-page anchor resolves; every new external link returns 200.🤖 Generated with Claude Code