From 66661e7922881d1b2d3b7db8e12c994c91fe0ee1 Mon Sep 17 00:00:00 2001
From: Alper Kanat <tunix@raptiye.org>
Date: Sat, 23 Jan 2016 22:09:58 +0200
Subject: [PATCH] Update README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index f65ddeb..8d77479 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
 # Dynamic DNS using DigitalOcean's DNS Services
+
+A script that pushes the public IP address of the running machine to DigitalOcean's DNS API's. It requires an existing A record to update.
+
+## Setup
+
+Assuming you already have a DigitalOcean account and your domain associated with it. Just add an A record with desired name and IP address. That's it!
+
+## Usage
+
+Pick one of the options below using the following settings:
+
+* **DIGITALOCEAN_TOKEN:** The token you generate in DigitalOcean's API settings.
+* **DOMAIN:** The domain your subdomain is registered at. (i.e. `foo.com` for `home.foo.com`)
+* **NAME:** Subdomain to use. (name in A record) (i.e. `home` for `home.foo.com`)
+* **SLEEP_INTERVAL:** Polling time in seconds. (default: 300)
+
+### Docker (Recommended)
+
+```
+$ docker pull tunix/digitalocean-dyndns
+$ docker run -d --name dyndns -e DIGITALOCEAN_TOKEN="your_token_here" -e DOMAIN="yourdomain.com" -e NAME="subdomain" -e SLEEP_INTERVAL=2 tunix/digitalocean-dyndns
+```
+
+### Manual
+
+You can also create a cronjob using below command:
+
+```
+$ DIGITALOCEAN_TOKEN="your_token_here" DOMAIN="yourdomain.com" NAME="subdomain" SLEEP_INTERVAL=2 ./dyndns.sh
+```