diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95e5e11..530e545 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -347,7 +347,7 @@ We appreciate packaging efforts for various package managers and distributions! Distribution-specific packaging should be maintained outside this repository: - **Nix flakes and modules** - Contribute to [nixpkgs](https://github.com/NixOS/nixpkgs) or maintain in a separate repo -- **Homebrew formulas** - Once tmpo meets requirements, we'll submit to homebrew-core +- **Homebrew formulas** - Maintained in our custom tap repository at [`DylanDevelops/homebrew-tmpo`](https://github.com/DylanDevelops/homebrew-tmpo). Once `tmpo` meets the required repository popularity metrics, we will submit it to `homebrew-core`. - **Linux packages** - AUR (Arch), APT/RPM repos, Snap, Flatpak, etc. - **System configuration** - Systemd units, init scripts, etc. - **Other package managers** - Scoop (Windows), Chocolatey, etc. diff --git a/README.md b/README.md index a72e986..8caafd3 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,9 @@ ## Installation -### Download Pre-built Binaries (Recommended) +### Installation Guides -Download the latest release for your platform from the [releases page](https://github.com/DylanDevelops/tmpo/releases). - -For detailed installation instructions for your platform: +See the installation guide for your platform: - [macOS Installation Guide](docs/installation/macos_installation.md) - [Linux Installation Guide](docs/installation/linux_installation.md) diff --git a/docs/installation/macos_installation.md b/docs/installation/macos_installation.md index cf9b181..17b21a4 100644 --- a/docs/installation/macos_installation.md +++ b/docs/installation/macos_installation.md @@ -7,7 +7,37 @@ This guide will walk you through installing tmpo on macOS. - macOS 11 (Big Sur) or later - For building from source: Go 1.25 or later -## Method 1: Download Pre-built Binary (Recommended) +## Method 1: Homebrew (Recommended) + +The easiest way to install tmpo on macOS is via [Homebrew](https://brew.sh/). + +```bash +brew tap DylanDevelops/tmpo +brew install tmpo +``` + +### Verify Installation + +```bash +tmpo --version +``` + +### Updating + +```bash +brew upgrade tmpo +``` + +### Uninstalling via Homebrew + +```bash +brew uninstall tmpo + +# Optionally, delete your tmpo data +rm -rf ~/.tmpo +``` + +## Method 2: Download Pre-built Binary ### Step 1: Download the Binary @@ -62,14 +92,6 @@ tmpo --version You should see the tmpo version information. -## Method 2: Homebrew (Coming Soon) - -Homebrew support is on the way! Once available, you'll be able to install with: - -```bash -brew install tmpo -``` - ## Method 3: Build from Source ### Step 1: Install Go @@ -206,7 +228,10 @@ tmpo stats To uninstall tmpo: ```bash -# Remove the binary +# If installed via Homebrew +brew uninstall tmpo + +# If installed manually sudo rm /usr/local/bin/tmpo # Optionally, delete your tmpo data