From 95f4abc34300575394255393357cfe7f31abfd78 Mon Sep 17 00:00:00 2001 From: johnjaylward Date: Fri, 2 Aug 2019 17:02:33 -0400 Subject: [PATCH] Update Readme with build instructions make the "requirements" section more specific and also adds simple build instructions. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14a9f0d..efc6b07 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,19 @@ A simple script in Go language to automatically update Digital ocean DNS records To find your Dynamic IP, this program will call out to https://ipv4bot.whatismyipaddress.com for ipv4 addresses and https://ipv6bot.whatismyipaddress.com for ipv6 addresses. This is to support dual-stack environments. -## requirements -Requires Git and Go for building. +## Requirements +Requires Git, Go 1.8+, and https://github.com/mitchellh/go-homedir for building. Requires that the record already exists in DigitalOcean's DNS so that it can be updated. (manually find your IP and add it to DO's DNS it will later be updated) Requires a Digital Ocean API key that can be created at https://cloud.digitalocean.com/account/api/tokens. +## Building +You first need to install the "homedir" module if you aren't using it in another project. To install the module, run `go get github.com/mitchellh/go-homedir` + +Once the module is fetched, you should be able to compile the program using `go build` + ## Usage ```bash git clone https://github.com/anaganisk/digitalocean-dynamic-dns-ip.git