Skip to content

Commit ae661c8

Browse files
authored
Merge pull request #37 from longtngo/fix/docker-install-hnswlib-core-dep
fix(docs): correct PyPI package name from headroom to headroom-ai
2 parents 7cf086c + 460250c commit ae661c8

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Get Headroom running in 5 minutes with these copy-paste examples.
88

99
```bash
1010
# Core only (minimal dependencies)
11-
pip install headroom
11+
pip install headroom-ai
1212

1313
# With proxy server
14-
pip install "headroom[proxy]"
14+
pip install "headroom-ai[proxy]"
1515

1616
# Everything
17-
pip install "headroom[all]"
17+
pip install "headroom-ai[all]"
1818
```
1919

2020
---

docs/troubleshooting.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ lsof -i :8787
2121
headroom proxy --port 8788
2222

2323
# 3. Check for missing dependencies
24-
pip install "headroom[proxy]"
24+
pip install "headroom-ai[proxy]"
2525

2626
# 4. Run with debug logging
2727
headroom proxy --log-level debug
@@ -223,13 +223,13 @@ client = HeadroomClient(
223223

224224
```bash
225225
# 1. Check it's installed in the right environment
226-
pip show headroom
226+
pip show headroom-ai
227227

228228
# 2. If using virtual environment, ensure it's activated
229229
source venv/bin/activate # or equivalent
230230

231231
# 3. Reinstall
232-
pip install --upgrade headroom
232+
pip install --upgrade headroom-ai
233233
```
234234

235235
### "ImportError: cannot import name 'X' from 'headroom'"
@@ -256,13 +256,13 @@ from headroom import (
256256

257257
```bash
258258
# For proxy server
259-
pip install "headroom[proxy]"
259+
pip install "headroom-ai[proxy]"
260260

261261
# For embedding-based relevance scoring
262-
pip install "headroom[relevance]"
262+
pip install "headroom-ai[relevance]"
263263

264264
# For everything
265-
pip install "headroom[all]"
265+
pip install "headroom-ai[all]"
266266
```
267267

268268
---

0 commit comments

Comments
 (0)