From 1e4a9c6cd0b72eb35cbac413a61b5a4cce8454df Mon Sep 17 00:00:00 2001
From: David Thorpe <djt@mutablelogic.com>
Date: Thu, 25 Jan 2024 08:51:50 +0100
Subject: [PATCH] Updated

---
 README.md | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 660d6dd..8bc3f88 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,45 @@
 # go-coredns-nomad
 
-coredns with nomad plugin for service discovery
+coredns with nomad plugin for service discovery. This repository will build a docker container 
+with coredns and the nomad plugin.
 
-Currently in progress, but this is how you build the container.
+## Using the container
 
-```sh
-docker build \
-  --tag ghcr.io/djthorpe/go-coredns-nomad:v1.11.1 \
-  --build-arg ARCH=$(arch) \
-  --build-arg PLATFORM=$(uname -s | tr '[:upper:]' '[:lower:]') \
-  --build-arg VERSION=v1.11.1 \
-  -f etc/docker/Dockerfile .  
-```
+In order to run this container, and have service discovery
+work on port 1053, you need to pass in the following environment variables:
 
-In order to run this container as a non-root user,
+  * `NOMAD_ADDR` - the address of the nomad server
+  * `NOMAD_TOKEN` - the token to use to query the nomad server
+  * `NOMAD_TTL` - the TTL for the DNS records, in seconds
+
+For example:
 
 ```sh
-docker run --name coredns --rm -p 1053:53 \
+docker run --name coredns-nomad --rm -p 1053:53 \
   --env NOMAD_ADDR=http://nomad:4646/ \
   --env NOMAD_TOKEN=XXXXXX \
   --env NOMAD_TTL=10 \
-  ghcr.io/djthorpe/go-coredns-nomad:v1.11.1 
+  ghcr.io/mutablelogic/coredns-nomad:v1.11.1
 ```
 
-When you want to test it using dig,
+When you want to test it using dig, query `<service>.<namespace>.nomad`. For example,
 
 ```sh
 dig +tcp -p 1053 @localhost service.default.nomad
 ```
 
+## Building the container
+
+You can use the pre-built container from the GitHub Container Registry (for arm64 or amd64 on Linux),
+or you can build it yourself.
+
+```sh
+git clone git@github.com:mutablelogic/go-coredns-nomad.git
+cd go-coredns-nomad
+docker build \
+  --tag ${REGISTRY}/${USERNAME}/coredns-nomad:v1.11.1 \
+  --build-arg ARCH=$(arch) \
+  --build-arg PLATFORM=$(uname -s | tr '[:upper:]' '[:lower:]') \
+  --build-arg VERSION=v1.11.1 \
+  -f etc/docker/Dockerfile .  
+```