From 2ab783c2ad45f52f08ac555745ef21c41e272b45 Mon Sep 17 00:00:00 2001
From: m5r <mokht@rmi.al>
Date: Thu, 27 Oct 2022 23:55:37 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1e4bcaa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# local-ip.dev
+
+[local-ip.dev](https://www.local-ip.dev) is a DNS service that resolves IP addresses from a specifically formatted hostname.  
+It was inspired by [local-ip.co](http://local-ip.co) and 
+
+<!-- TODO: provide certs for ez local dev that requires HTTPS -->
+
+## Usage
+
+```sh
+$ dig 10-0-1-29.my.local-ip.dev +short
+10.0.1.29
+$ dig 127.0.0.1.my.local-ip.dev +short
+127.0.0.1
+```