Skip to content

Commit 44841ca

Browse files
committed
docs: add Homebrew installation to README
1 parent 594fd39 commit 44841ca

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This produces documentation that's accurate to both the code AND the actual user
3535

3636
```bash
3737
# 1. Install the CLI
38-
uv tool install aidocs
38+
brew install binarcode/aidocs/aidocs
3939

4040
# 2. Add to your project
4141
cd your-project
@@ -47,17 +47,24 @@ aidocs init .
4747

4848
**Alternative installation:**
4949
```bash
50-
# From GitHub (latest)
51-
uv tool install aidocs --from git+https://github.com/binarcode/aidocs-cli.git
50+
# Homebrew (macOS/Linux)
51+
brew install binarcode/aidocs/aidocs
52+
53+
# uv (recommended for Python users)
54+
uv tool install aidocs
5255

53-
# Or use pipx
56+
# pipx
5457
pipx install aidocs
58+
59+
# From GitHub (latest)
60+
uv tool install aidocs --from git+https://github.com/binarcode/aidocs-cli.git
5561
```
5662

5763
**Updating:**
5864
```bash
59-
aidocs update # Update from PyPI
60-
aidocs update --github # Update from GitHub (latest)
65+
brew upgrade aidocs # Homebrew
66+
aidocs update # PyPI (uv/pipx/pip)
67+
aidocs update --github # GitHub (latest)
6168
aidocs init . --force # Reinstall commands in project
6269
```
6370

0 commit comments

Comments
 (0)