From fd83d4a207a19d3fc3eaea8c53d5bb5a3307dc1c Mon Sep 17 00:00:00 2001 From: Eric Zhang Date: Sun, 5 Jun 2022 13:00:16 -0400 Subject: [PATCH] Add Homebrew installation instructions --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 83cfed7..35a27e8 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,13 @@ Similar to [localtunnel](https://github.com/localtunnel/localtunnel) and [ngrok] ## Installation -The easiest way to install bore is from prebuilt binaries. These are available on the [releases page](https://github.com/ekzhang/bore/releases) for macOS, Windows, and Linux. Just unzip the appropriate file for your platform and move the bore executable into a folder on your PATH. +If you're on macOS, `bore` is packaged as a Homebrew formula. + +```shell +brew install ekzhang/bore/bore +``` + +Otherwise, the easiest way to install bore is from prebuilt binaries. These are available on the [releases page](https://github.com/ekzhang/bore/releases) for macOS, Windows, and Linux. Just unzip the appropriate file for your platform and move the `bore` executable into a folder on your PATH. You also can build `bore` from source using [Cargo](https://doc.rust-lang.org/cargo/), the Rust package manager. This command installs the `bore` binary at a user-accessible path.