From e031f47f4a796c03c06b9085a65ca10913e0abdf Mon Sep 17 00:00:00 2001
From: ZueffC <zueffc@gmail.com>
Date: Fri, 24 Jan 2025 03:25:07 +0300
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..895a5be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Cloudflare DNS manager 
+This package is an extension for the ["DNS Manager"](git.uoc.run.place/OxFF/dns-manager). 
+The main goal of the project is to provide robust and unified interface for interacting with various DNS. 
+
+In this package now includes: 
+- [x] Getting all DNS records of a custom zone
+- [x] Creating new DNS records on a custom zone
+- [x] Deleting existed records on a custom zone
+- [x] Update existed records on a custom zone
+
+TO-DO:
+- [ ] Provide defense against data races
+- [ ] Improve quality of error handling (e.g., check matches the response to expectations or not)
+- [ ] Provide ability to auth with Global API Key and email, instead of using API Tokens
\ No newline at end of file