From b88c10bf839b6f4b07330cd8f4c13210bd192f8a Mon Sep 17 00:00:00 2001
From: Tobi Lutke <tobi@shopify.com>
Date: Sun, 15 Feb 2026 16:45:35 -0400
Subject: [PATCH] docs: show bun/node install and package scope

Document both Node and Bun execution paths.
- Update install examples to `@tobilu/qmd` for npm and bun.
- Add npx/bunx one-off usage examples.
- Reflect Bun as first-class supported runtime in requirements.
---
 README.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 5b67301..2e2e60c 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,14 @@ QMD combines BM25 full-text search, vector semantic search, and LLM re-ranking
 ## Quick Start
 
 ```sh
-# Install globally (Node)
-npm install -g github:tobi/qmd
+# Install globally (Node or Bun)
+npm install -g @tobilu/qmd
+# or
+bun install -g @tobilu/qmd
+
+# Or run directly
+npx @tobilu/qmd ...
+bunx @tobilu/qmd ...
 
 # Create collections for your notes, docs, and meeting transcripts
 qmd collection add ~/notes --name notes
@@ -232,7 +238,7 @@ The `query` command uses **Reciprocal Rank Fusion (RRF)** with position-aware bl
 ### System Requirements
 
 - **Node.js** >= 22
-- **Bun** >= 1.0.0 (optional; supported for local development)
+- **Bun** >= 1.0.0
 - **macOS**: Homebrew SQLite (for extension support)
   ```sh
   brew install sqlite
@@ -253,7 +259,9 @@ Models are downloaded from HuggingFace and cached in `~/.cache/qmd/models/`.
 ## Installation
 
 ```sh
-npm install -g github:tobi/qmd
+npm install -g @tobilu/qmd
+# or
+bun install -g @tobilu/qmd
 ```
 
 ### Development