From 880dc03c58e1efde671ecceabe8800250a8e6ac4 Mon Sep 17 00:00:00 2001
From: Ferenc Schulcz <schulcz.ferenc@gmail.com>
Date: Sat, 3 Feb 2024 23:46:32 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..af67e20
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+Simple DynDNS server
+====================
+
+This is a simple DynDNS server implementation that builds on the Knot DNS server.
+
+Features
+--------
+
+Register a new domain:
+
+```
+$ curl -4 'http://localhost:3000/register?domain=myname'
+{
+	"domainName":"myname.test.test",
+	"token":"ecf43b7659fc09d81c4b55ded31d6b0b",
+	"message":"DNS record is not served until first DynDNS update."
+}
+```
+
+Update DNS record:
+
+```
+curl -4 'http://localhost:3000/update?token=ecf43b7659fc09d81c4b55ded31d6b0b&ip=1.1.1.1'
+{
+	"message":"Updated."
+}
+```
+
+**WARNING: You need to use a proxy that handles authentication and authorization!**
+
+Dependencies
+------------
+
+- [Knot DNS server](https://www.knot-dns.cz/) - Open source DNS server developed by the Czech domain registrar
+- [MongoDB](https://www.mongodb.com/) - NoSQL database
+
+Running
+-------
+
+Setup: `npm install`
+
+`sudo node index.js`
\ No newline at end of file
-- 
GitLab