From e77003125d0df8a315a585c2129bcea06028f56b Mon Sep 17 00:00:00 2001
From: Nathan Woodburn <github@nathan.woodburn.au>
Date: Thu, 9 Nov 2023 22:23:11 +1100
Subject: [PATCH] docs: Added readme info

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4a51886..4d9efbf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# hip02-resolver
+# HIP02 Resolver
+
+### Usage
+HNS address lookup
+
+`curl https://hip02.woodburn.au/<domain>`
+
+### Examples
+
+Getting HNS address for nathan.woodburn  
+`curl https://hip02.woodburn.au/nathan.woodburn`  
+Response: `hs1qjrtqpqk3xvzf5cxzss4wh2y9qyamksmv5sf5tt`
+
+Getting HNS address for nathan.woodburn in JSON  
+`curl https://hip02.woodburn.au/nathan.woodburn.json`  
+Response: `{"address":"hs1qjrtqpqk3xvzf5cxzss4wh2y9qyamksmv5sf5tt","success":true}`
+
+Getting BTC address for nathan.woodburn  
+`curl https://hip02.woodburn.au/nathan.woodburn?token=btc`  
+Response: `bc1qhs94zzcw64qnwq4hvk056rwxwvgrkd7tq7d4xw`  
+`curl https://hip02.woodburn.au/nathan.woodburn.json?token=btc`  
+Response: `{"address":"bc1qhs94zzcw64qnwq4hvk056rwxwvgrkd7tq7d4xw","success":true}`
+
+### Docker Usage
+
+`docker run -d -p 5000:5000 --name hip02 git.woodburn.au/nathanwoodburn/hip02-resolver:latest`
\ No newline at end of file