diff --git a/README.md b/README.md index f3e96f3..c943354 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ # πŸš€ Cloudflare DDNS +Access your home network remotely via a custom domain name without a static IP! + A small, πŸ•΅οΈ privacy centric, and ⚑ lightning fast multi-architecture Docker image for self hosting projects. +## πŸ‡ΊπŸ‡Έ Origin + +This script was written for the Raspberry Pi platform to enable low cost, simple self hosting to promote a more decentralized internet. On execution, the script fetches public IPv4 and IPv6 addresses and creates/updates DNS records for the subdomains in Cloudflare. Stale, duplicate DNS records are removed for housekeeping. + +## πŸ“Š Stats + | Size | Downloads | Discord | | ------------- | ------------- | ------------- | | [![cloudflare-ddns docker image size](https://img.shields.io/docker/image-size/timothyjmiller/cloudflare-ddns?style=flat-square)](https://hub.docker.com/r/timothyjmiller/cloudflare-ddns "cloudflare-ddns docker image size") | [![Total DockerHub pulls](https://img.shields.io/docker/pulls/timothyjmiller/cloudflare-ddns?style=flat-square)](https://hub.docker.com/r/timothyjmiller/cloudflare-ddns "Total DockerHub pulls") | [![Official Discord Server](https://img.shields.io/discord/785778163887112192?style=flat-square)](https://discord.gg/UgGmwMvNxm "Official Discord Server") @@ -15,14 +23,6 @@ A small, πŸ•΅οΈ privacy centric, and ⚑ lightning fast multi-architecture Dock 5. Open source for open audits 6. Regular updates -## πŸ’Ό Use Case - -Access your home network remotely via a custom domain name without a static IP! - -## πŸ‡ΊπŸ‡Έ Origin - -This script was written for the Raspberry Pi platform to enable low cost, simple self hosting to promote a more decentralized internet. On execution, the script fetches public IPv4 and IPv6 addresses and creates/updates DNS records for the subdomains in Cloudflare. Stale, duplicate DNS records are removed for housekeeping. - ## 🚦 Getting Started First copy the example configuration file into the real one.