readme

README.md

@@ -1,2 +1,36 @@
-# docker-ddns-cloudflare
+# Docker DDNS Cloudflare
-Cloudflare DDNS Script
+This container is an adapted version of [this](https://gist.github.com/benkulbertis/fff10759c2391b6618dd) script.
+
+## Quickstart 🚀
+
+Create an `.env` file:
+
+```bash
+EMAIL=my@mail.com
+KEY=my_api_key
+ZONE=example.org
+DNS_RECORD=some.example.org
+```
+
+Run the container
+
+```bash
+docker run -d --name ddns --restart always --env-file .env cupcakearmy/ddns-cloudflare
+```
+
+To check logs: 
+
+```bash
+docker logs ddns
+```
+
+### Docker-Copmose
+
+With docker-compose:
+
+```bash
+git clone https://github.com/CupCakeArmy/docker-ddns-cloudflare.git
+cp .sample.env .env
+# Edit the .env file with your data
+docker-compose up -d
+```