From 425682d7f772e66289ef0e0c97eb0a864ace9b97 Mon Sep 17 00:00:00 2001
From: Joshua Avalon <joshuaavalon@gmail.com>
Date: Tue, 19 Sep 2017 17:13:39 +0800
Subject: [PATCH] Create README.md

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..42378c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# joshuaavalon/docker-cloudflare
+[![version](https://images.microbadger.com/badges/version/joshuaavalon/docker-cloudflare.svg)](https://microbadger.com/images/joshuaavalon/docker-cloudflare) 
+[![](https://images.microbadger.com/badges/image/joshuaavalon/docker-cloudflare.svg)](https://microbadger.com/images/joshuaavalon/docker-cloudflare) 
+![Docker Pulls](https://img.shields.io/docker/pulls/joshuaavalon/docker-cloudflare.svg) 
+![Docker Stars](https://img.shields.io/docker/stars/joshuaavalon/docker-cloudflare.svg?colorB=dfb317) 
+[![Docker Automated build](https://img.shields.io/docker/automated/joshuaavalon/docker-cloudflare.svg)](https://hub.docker.com/r/joshuaavalon/docker-cloudflare/) 
+[![Docker build](https://img.shields.io/docker/build/joshuaavalon/docker-cloudflare.svg)](https://hub.docker.com/r/joshuaavalon/docker-cloudflare/) 
+[![MIT](https://img.shields.io/github/license/joshuaavalon/docker-cloudflare.svg)](https://github.com/joshuaavalon/docker-cloudflare/blob/master/LICENSE)
+
+The is a simple docker using bash and curl to update DNS record on [Cloudflare](https://www.cloudflare.com). Inspired by [rasmusbe/cloudflare-update-record.sh](https://gist.github.com/rasmusbe/fc2e270095f1a3b41348/)
+
+Compare to [nouchka/cloudflare-dyndns](https://hub.docker.com/r/nouchka/cloudflare-dyndns/) (4.0):
+ * Smaller size: 12MB vs 54MB
+ * Able to update subdomain
+ * Update when IP is changed
+
+## Usage
+```
+docker run  \
+	-d \
+	-e ZONE=example.com \
+	-e HOST=example.com \
+	-e API=11111111111111111111111111111111 \
+	-e EMAIL=example@example.com \
+	-e TTL=1 \
+	-e PROXY=true \
+	-e WAIT=300 \
+	--name cloudflare \
+joshuaavalon/docker-cloudflare
+```
+
+## Parameters
+`ZONE`: Domain, e.g. example.com
+
+`HOST`: DNS record to be updated, e.g. example.com, subdomain.example.com
+
+`API`: Cloudflare API key
+
+`EMAIL`: Cloudflare Email
+
+`TTL`: Time to live for DNS record. Value of 1 is 'automatic'. min value:1 max value:2147483647.
+
+`PROXY`: Whether the record is receiving the performance and security benefits of Cloudflare. `true` to enable; `false` to disable
+
+`WAIT`: Time to check if ip changed. Argument for `sleep`.
+```
+.5 # Waits 0.5 second.
+5  # Waits 5 seconds.
+5s # Waits 5 seconds.
+5m # Waits 5 minutes.
+5h # Waits 5 hours.
+5d # Waits 5 days.
+```