docs: Added readme info
All checks were successful
Build Docker / Build Image (push) Successful in 20s

This commit is contained in:
Nathan Woodburn 2023-11-09 22:23:11 +11:00
parent a805f8c451
commit e77003125d
Signed by: nathanwoodburn
GPG Key ID: 203B000478AD0EF1

View File

@ -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`