ai-workspace-services/qmd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: show bun/node install and package scope

Browse Source 
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.
This commit is contained in:
Tobi Lutke 2026-02-15 16:45:35 -04:00
parent 13e8473455
commit b88c10bf83
No known key found for this signature in database
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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