From 08128bffb0a0e629541a647072ea8c30ef65d069 Mon Sep 17 00:00:00 2001 From: moneycaringcoder Date: Wed, 8 Apr 2026 22:33:24 +0200 Subject: [PATCH] docs: update install section with Homebrew, Scoop, and version note go install doesn't embed version info via ldflags, causing the update checker to always show a new version available. Added all install methods and a note about this limitation. --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 855bf60..34829c5 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,46 @@ A lightweight terminal dashboard for watching GitHub repository activity in real ## Install +### Homebrew (macOS / Linux) + +```bash +brew install moneycaringcoder/tap/gitstream +``` + +### Scoop (Windows) + +```powershell +scoop bucket add moneycaringcoder https://github.com/moneycaringcoder/scoop-bucket +scoop install gitstream +``` + +### Go + ```bash go install github.com/moneycaringcoder/gitstream-tui/cmd/gitstream@latest ``` -Or download a binary from [Releases](https://github.com/moneycaringcoder/gitstream-tui/releases). +Requires Go 1.24+. The binary is installed to `$GOPATH/bin` (usually `~/go/bin`). + +> **Note:** `go install` builds from source and does not embed version info. For automatic update checks to work correctly, use one of the other install methods or download a pre-built binary. + +### Pre-built binaries + +Download the latest release for your platform from [Releases](https://github.com/moneycaringcoder/gitstream-tui/releases). Extract and place the binary somewhere on your `PATH`. + +## Updating + +### Homebrew + +```bash +brew upgrade gitstream +``` + +### Scoop + +```powershell +scoop update gitstream +``` ## Usage