From 22a5e80aae60b0ba46f55d99cee058c192480496 Mon Sep 17 00:00:00 2001 From: Andrew Gaul Date: Sat, 30 Sep 2017 10:54:22 -0700 Subject: [PATCH] Expand installation instructions with dependencies References #26. --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 473de0a..8209f9f 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ Compy is an HTTP/HTTPS forward proxy with content compression/transcoding capabi One use case is to reduce bandwidth usage when browsing on limited mobile broadband connection. -Features: ---------- +Features +-------- - HTTPS proxy (encrypted connection between client and proxy) - man in the middle support (compress HTTPS traffic) @@ -21,9 +21,17 @@ Features: Installation ------------ +compy needs a few libraries to compile. +On Ubuntu, run `apt-get install -y libjpeg8 openssl ssl-cert`. +On macOS, run `brew install jpeg`. Then compile via: + +```ShellSession +$ go get github.com/barnacs/compy +$ cd go/src/github.com/barnacs/compy/ +$ go install ``` -go get github.com/barnacs/compy -``` + +go will generate the binary at `go/bin/compy`. ### HTTPS To use the proxy over HTTPS, you will need a certificate for your host. If you don't already have one, you can get one for [free](https://letsencrypt.org/) or you can generate a self-signed cert by running: