Skip to content

docs: revamp README (+ pi plugin, fix docs link) - #12

Merged
prabod merged 1 commit into
mainfrom
docs/readme-revamp
Jun 30, 2026
Merged

prabod merged 1 commit into
mainfrom
docs/readme-revamp

Conversation

@prabod

@prabod prabod commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Makes the repo landing more professional and fills two gaps.

Changes

  • Professional header — centered title, tagline, and badges (Docs / License / Platform / Bindings), plus a concise features list.
  • "Use it as a coding agent" section — documents the pi-basert extension (serve a model → pi installpi), which the README didn't mention at all.
  • Fixed the docs linkbasecompute.co/docsdocs.basecompute.co (we moved docs to the subdomain).
  • Quant variant note — mentions :default-q8 / --variant.
  • Dropped an internal implementation aside ("kernels embedded; no metallib needed") from the Python example.

Content is otherwise preserved (Quickstart, CLI table, repo layout, license).

- Professional header (centered title, tagline, badges) and a features section.
- Add a 'Use it as a coding agent' section for the pi-basert extension.
- Fix the docs link (basecompute.co/docs -> docs.basecompute.co).
- Note quant-variant selection; drop an internal implementation aside.
@prabod
prabod merged commit faf6b85 into main Jun 30, 2026
3 checks passed
@prabod
prabod deleted the docs/readme-revamp branch June 30, 2026 08:13
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