Skip to content

Commit

Permalink
add releases to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmoriarty committed Mar 25, 2020
1 parent 80b4c59 commit 80103e5
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Alpaca

![Latest Tag][2] ![GitHub Workflow Status][3] ![GitHub Releases][4]

Alpaca is an HTTP/HTTPS proxy. It is designed for users of Unix tools, who
operate inside networks that use proxy auto-configuration (PAC) files and
require NTLM authentication.
Expand All @@ -8,15 +10,19 @@ It currently does not yet implement many important features, such as SOCKS,
HTTP/2, and many of the predefined JS functions that PAC files use.
Contributions are welcome, please reach out to me if you'd like to help!

## Installation and Usage
## Download

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

To download and install Alpaca, use:
## Install From Source

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

Then start Alpaca by running the `alpaca` binary.
## Usage

Start Alpaca by running the `alpaca` binary.

If your proxy requires NTLM authentication, you'll need to supply your domain and
username (via command-line flags) and a password (via a prompt):
Expand Down Expand Up @@ -48,3 +54,8 @@ vice-versa), the proxies listed in the PAC script might become unreachable.
When this happens, Alpaca will temporarily bypass the parent proxy and send
requests directly, so there's no need to manually unset/re-set `http_proxy` and
`https_proxy` as you move between networks.

[1]: https://github.com/samuong/alpaca/releases
[2]: https://img.shields.io/github/v/tag/samuong/alpaca.svg?logo=github&label=latest
[3]: https://img.shields.io/github/workflow/status/samuong/alpaca/Continuous%20Integration/master
[4]: https://img.shields.io/github/downloads/samuong/alpaca/latest/total

0 comments on commit 80103e5

Please sign in to comment.