feat(docker): improve README for Docker usage

aerialls · Jun 26, 2020 · 4cc6f43 · 4cc6f43
1 parent 6e4ccdd
commit 4cc6f43
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM gcr.io/distroless/static
+FROM gcr.io/distroless/base
 
 COPY scaleway-ddns /
 ENTRYPOINT ["/scaleway-ddns"]
diff --git a/README.md b/README.md
@@ -6,10 +6,27 @@
 
 Dynamic DNS service based on [Scaleway DNS](https://console.scaleway.com/domains/external).
 
-## Usage
+## Setup
+
+### From binaries
+
+Download the most suitable binary from [the releases tab](https://github.com/aerialls/scaleway-ddns/releases). Builds are available for Linux, macOS and Windows.
 
+```bash
+tar xf scaleway-ddns_X.X.X_linux_amd64.tar.gz
+./scaleway-ddns_X.X.X_linux_amd64/scaleway-ddns
 ```
-scaleway-ddns --config /etc/scaleway-ddns/scaleway-ddns.yml
+
+### Using the docker image
+
+```bash
+docker run --rm -d  --name scaleway-ddns -v `pwd`:/config aerialls/scaleway-ddns:latest --config /config/scaleway-ddns.yml
+```
+
+## Usage
+
+```bash
+./scaleway-ddns --config /etc/scaleway-ddns/scaleway-ddns.yml --dry-run --verbose
 ```
 
 ## Parameters