chopratejas commited on
Commit
b1479e8
·
2 Parent(s): 297230ccd98222

Merge pull request #37 from longtngo/fix/docker-install-hnswlib-core-dep

Browse files
Files changed (2) hide show
  1. docs/quickstart.md +3 -3
  2. docs/troubleshooting.md +6 -6
docs/quickstart.md CHANGED
@@ -8,13 +8,13 @@ Get Headroom running in 5 minutes with these copy-paste examples.
8
 
9
  ```bash
10
  # Core only (minimal dependencies)
11
- pip install headroom
12
 
13
  # With proxy server
14
- pip install "headroom[proxy]"
15
 
16
  # Everything
17
- pip install "headroom[all]"
18
  ```
19
 
20
  ---
 
8
 
9
  ```bash
10
  # Core only (minimal dependencies)
11
+ pip install headroom-ai
12
 
13
  # With proxy server
14
+ pip install "headroom-ai[proxy]"
15
 
16
  # Everything
17
+ pip install "headroom-ai[all]"
18
  ```
19
 
20
  ---
docs/troubleshooting.md CHANGED
@@ -21,7 +21,7 @@ lsof -i :8787
21
  headroom proxy --port 8788
22
 
23
  # 3. Check for missing dependencies
24
- pip install "headroom[proxy]"
25
 
26
  # 4. Run with debug logging
27
  headroom proxy --log-level debug
@@ -223,13 +223,13 @@ client = HeadroomClient(
223
 
224
  ```bash
225
  # 1. Check it's installed in the right environment
226
- pip show headroom
227
 
228
  # 2. If using virtual environment, ensure it's activated
229
  source venv/bin/activate # or equivalent
230
 
231
  # 3. Reinstall
232
- pip install --upgrade headroom
233
  ```
234
 
235
  ### "ImportError: cannot import name 'X' from 'headroom'"
@@ -256,13 +256,13 @@ from headroom import (
256
 
257
  ```bash
258
  # For proxy server
259
- pip install "headroom[proxy]"
260
 
261
  # For embedding-based relevance scoring
262
- pip install "headroom[relevance]"
263
 
264
  # For everything
265
- pip install "headroom[all]"
266
  ```
267
 
268
  ---
 
21
  headroom proxy --port 8788
22
 
23
  # 3. Check for missing dependencies
24
+ pip install "headroom-ai[proxy]"
25
 
26
  # 4. Run with debug logging
27
  headroom proxy --log-level debug
 
223
 
224
  ```bash
225
  # 1. Check it's installed in the right environment
226
+ pip show headroom-ai
227
 
228
  # 2. If using virtual environment, ensure it's activated
229
  source venv/bin/activate # or equivalent
230
 
231
  # 3. Reinstall
232
+ pip install --upgrade headroom-ai
233
  ```
234
 
235
  ### "ImportError: cannot import name 'X' from 'headroom'"
 
256
 
257
  ```bash
258
  # For proxy server
259
+ pip install "headroom-ai[proxy]"
260
 
261
  # For embedding-based relevance scoring
262
+ pip install "headroom-ai[relevance]"
263
 
264
  # For everything
265
+ pip install "headroom-ai[all]"
266
  ```
267
 
268
  ---