From 6d06fd82624c9446495baba97abded393ba00594 Mon Sep 17 00:00:00 2001
From: Mike Heier <mike@heier.io>
Date: Wed, 13 Jul 2022 20:56:34 -0400
Subject: [PATCH] Add a README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f644e99
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+<h1>Azure DNS Update</h1>
+
+A utility that can be used to keep your Azure DNS pointed to your on-premises/home public IP address.
+
+<br>
+
+## Features
+
+- Includes one template based on this [article](https://blog.rocketseat.com.br/como-fazer-um-bom-readme);
+- Can be run on a schedule
+- Can be run as a Docker container
+
+## Settings
+
+These settings must be configured in a .env file in the same directory as the script.
+
+```bash
+SUBSCRIPTION_ID=<YOUR_SUBSCRIPTION_ID_GUID>
+CLIENT_ID=<YOUR_CLIENT_ID_GUID>
+CLIENT_SECRET=<YOUR_CLIENT_SECRET>
+TENANT_ID=<YOUR_TENANT_ID_GUID>
+
+RESOURCE_GROUP_NAME=<YOUR_RESOURCE_GROUP_NAME>
+ZONE_NAME=<YOUR_DNS_ZONE_NAME>
+RECORD_TYPE=A
+RELATIVE_RECORD_SET_NAME=@
+```
+