From 7157144c75bba45336fffdbb88cfcd90505c7fb7 Mon Sep 17 00:00:00 2001 From: Duc-Tam Nguyen Date: Fri, 19 Jun 2026 17:16:11 +0700 Subject: [PATCH] Document Homebrew and Scoop, and fix the deb/rpm filenames The README never mentioned the package managers and the docs covered Homebrew but not Scoop, even though both ship from every release. Add the Homebrew (macOS) and Scoop (Windows) channels to both. Fix the Linux package globs: GoReleaser names them kage__amd64.deb and kage--1.x86_64.rpm, not kage_*_linux_amd64.{deb,rpm}, so the documented commands matched nothing. --- README.md | 13 ++++++++++++- docs/content/getting-started/installation.md | 18 ++++++++++++++---- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e650d2c..1525971 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,18 @@ Full docs and guides live at **[kage.tamnd.com](https://kage.tamnd.com)**. go install github.com/tamnd/kage/cmd/kage@latest ``` -Prefer a prebuilt binary? Grab an archive, a `.deb`/`.rpm`/`.apk`, or a checksum from [releases](https://github.com/tamnd/kage/releases). Or skip installing Chrome yourself and use the container image, which bundles Chromium: +Prefer a prebuilt binary? Grab an archive, a `.deb`/`.rpm`/`.apk`, or a checksum from [releases](https://github.com/tamnd/kage/releases). On a Mac or Windows box, the package managers know it: + +```bash +# Homebrew (macOS) +brew install tamnd/tap/kage + +# Scoop (Windows) +scoop bucket add tamnd https://github.com/tamnd/scoop-bucket +scoop install kage +``` + +Or skip installing Chrome yourself and use the container image, which bundles Chromium: ```bash docker run --rm -v "$PWD/out:/out" ghcr.io/tamnd/kage clone paulgraham.com diff --git a/docs/content/getting-started/installation.md b/docs/content/getting-started/installation.md index ac02889..5db19f5 100644 --- a/docs/content/getting-started/installation.md +++ b/docs/content/getting-started/installation.md @@ -1,6 +1,6 @@ --- title: "Installation" -description: "Install kage from Go, Homebrew, a release archive, a Linux package, or the container image, and point it at a browser." +description: "Install kage from Go, Homebrew, Scoop, a release archive, a Linux package, or the container image, and point it at a browser." weight: 20 --- @@ -12,12 +12,22 @@ kage is a single binary. Pick whichever channel suits you. go install github.com/tamnd/kage/cmd/kage@latest ``` -## Homebrew +## Homebrew (macOS) ```bash brew install tamnd/tap/kage ``` +The cask installs the prebuilt macOS binary. On Linux, use the packages below or +`go install`. + +## Scoop (Windows) + +```bash +scoop bucket add tamnd https://github.com/tamnd/scoop-bucket +scoop install kage +``` + ## Release archives and Linux packages Every [release](https://github.com/tamnd/kage/releases) attaches `tar.gz` @@ -28,10 +38,10 @@ signature. Download the one for your platform, extract `kage`, and put it on you ```bash # Debian/Ubuntu -sudo dpkg -i kage_*_linux_amd64.deb +sudo dpkg -i kage_*_amd64.deb # Fedora/RHEL -sudo rpm -i kage_*_linux_amd64.rpm +sudo rpm -i kage-*.x86_64.rpm ``` ## Container