Skip to content

Commit

Permalink
Add instructions to install via Homebrew (#56)
Browse files Browse the repository at this point in the history
Also, I've moved the "Download Binary" method down one section, because I think
that Homebrew and Go both provide a better (automated) way to keep the binary
up-to-date.

Also, I've added http:// to http_proxy and https_proxy. This seems to be
needed by yarn.

Fixes #55
  • Loading branch information
samuong authored Jun 30, 2020
1 parent 5760981 commit 72a0aad
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,31 @@
Alpaca is a local HTTP proxy for command-line tools. It supports proxy
auto-configuration (PAC) files and NTLM authentication.

## Download Binary
## Install using Homebrew

Alpaca can be downloaded from the [GitHub releases page][1].
If you're using macOS and use [Homebrew](https://brew.sh/), you can install
using:

```sh
$ brew tap samuong/alpaca
$ brew install samuong/alpaca/alpaca
```

Launch Alpaca by running `alpaca`, or by using `brew services start alpaca`.

## Build from Sources
## Install using Go

If you've got the [Go](https://golang.org/cmd/go/) tool installed, you can
install using:

```sh
$ go get -v -u github.com/samuong/alpaca
```

## Download Binary

Alpaca can be downloaded from the [GitHub releases page][1].

## Usage

Start Alpaca by running the `alpaca` binary.
Expand All @@ -38,8 +53,8 @@ You also need to configure your tools to send requests via Alpaca. Usually this
will require setting the `http_proxy` and `https_proxy` environment variables:

```sh
$ export http_proxy=localhost:3128
$ export https_proxy=localhost:3128
$ export http_proxy=http://localhost:3128
$ export https_proxy=http://localhost:3128
$ curl -s https://raw.githubusercontent.com/samuong/alpaca/master/README.md
# Alpaca
...
Expand Down

0 comments on commit 72a0aad

Please sign in to comment.