From 11c852ee91f0217b675e77f3129ee182ac0e9b17 Mon Sep 17 00:00:00 2001 From: Daniel McCarney Date: Wed, 28 Feb 2018 13:38:44 -0500 Subject: [PATCH] README: simplify installation instructions with `go get`. (#41) * README: simplify installation instructions with `go get`. Prior to this commit the installation instructions in the README had you use `git clone` and then `go build`. This can be collapsed into one step using a more idiomatic `go get` command. This commit updates the README accordingly. * Also mention supported config file locations * Fix go get URL --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f70df08..6441913 100644 --- a/README.md +++ b/README.md @@ -110,13 +110,11 @@ Check out how in the INSTALL section. 1) Install [Go 1.9 or newer](https://golang.org/doc/install) -2) Clone this repo: `git clone https://github.com/joohoi/acme-dns $GOPATH/src/acme-dns` +2) Install acme-dns: `go get github.com/joohoi/acme-dns/...` -3) Build ACME-DNS: `go build` +3) Edit config.cfg to suit your needs (see [configuration](#configuration)). `acme-dns` will read the configuration file from `/etc/acme-dns/config.cfg` or `./config.cfg` -4) Edit config.cfg to suit your needs (see [configuration](#configuration)) - -5) Run acme-dns. Please note that acme-dns needs to open a privileged port (53, domain), so it needs to be run with elevated privileges. +4) Run acme-dns. Please note that acme-dns needs to open a privileged port (53, domain), so it needs to be run with elevated privileges. ## Using Docker