Skip to content

docs: add badges and table of contents to README#83

Open
Gingiris wants to merge 1 commit intoz-lab:mainfrom
Gingiris:docs/add-badges-and-toc
Open

docs: add badges and table of contents to README#83
Gingiris wants to merge 1 commit intoz-lab:mainfrom
Gingiris:docs/add-badges-and-toc

Conversation

@Gingiris
Copy link
Copy Markdown

What this PR does

Adds status badges and a table of contents to the README for better discoverability and navigation.

Why

The README has 6 main sections covering different backends (vLLM, SGLang, Transformers, MLX) and evaluation, but no table of contents for quick navigation. Adding badges (MIT license, stars, last commit, arXiv paper) helps visitors quickly assess project status and find the paper — the arXiv badge in particular complements the existing text links by making the paper immediately visible in the badge row.

Changes

  • Added 4 badges: MIT license, GitHub stars, last commit, and arXiv paper link
  • Added a table of contents linking to all 6 top-level sections

🤖 This PR was created with AI assistance and reviewed by a human.

@Gingiris
Copy link
Copy Markdown
Author

Hi! Just checking in — happy to adjust anything if needed. Let me know if you have any feedback. 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant