docs: Added readme info
All checks were successful
Build Docker / Build Image (push) Successful in 20s
All checks were successful
Build Docker / Build Image (push) Successful in 20s
This commit is contained in:
parent
a805f8c451
commit
e77003125d
27
README.md
27
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`
|
Loading…
Reference in New Issue
Block a user