From a959bfd10137b6f987d1a07f1588265f10da47c2 Mon Sep 17 00:00:00 2001 From: Patrick Bertsch Date: Thu, 2 Apr 2026 09:10:12 -0600 Subject: [PATCH] docs: add Homebrew as recommended install method in README and pub.dev README --- README.md | 13 +++++++++++-- probe_agent/README.md | 8 ++++++-- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2676143..c694447 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,16 @@ The **ProbeAgent** is a Dart package you add to your Flutter app as a dev depend ## Installation -### Option A — Download pre-built binary (recommended for CI/CD) +### Option A — Homebrew (macOS + Linux, recommended) + +```bash +brew tap AlphaWaveSystems/tap +brew install probe +``` + +Upgrades are handled automatically with `brew upgrade probe`. + +### Option B — Download pre-built binary (recommended for CI/CD) Pre-built binaries for Linux, macOS (Intel + Apple Silicon), and Windows are attached to every [GitHub Release](https://github.com/AlphaWaveSystems/flutter-probe/releases). @@ -77,7 +86,7 @@ curl -Lo probe https://github.com/AlphaWaveSystems/flutter-probe/releases/latest chmod +x probe && sudo mv probe /usr/local/bin/ ``` -### Option B — Build from source +### Option C — Build from source ```bash git clone https://github.com/AlphaWaveSystems/flutter-probe.git diff --git a/probe_agent/README.md b/probe_agent/README.md index ab8d4d8..0d3c792 100644 --- a/probe_agent/README.md +++ b/probe_agent/README.md @@ -26,10 +26,14 @@ Both are required. The agent alone does nothing without the CLI to drive it. The `probe` CLI is a Go binary. Install via one of: ```bash -# Option A: Go install +# Option A: Homebrew (macOS + Linux) +brew tap AlphaWaveSystems/tap +brew install probe + +# Option B: Go install go install github.com/AlphaWaveSystems/flutter-probe/cmd/probe@latest -# Option B: Download from GitHub Releases +# Option C: Download from GitHub Releases # https://github.com/AlphaWaveSystems/flutter-probe/releases/latest ```