docs: Added readme info

2023-11-08 14:05:55 +11:00 · 2023-11-08 14:05:55 +11:00 · 27af90fcc6
commit 27af90fcc6
parent 3b7c587e54
2 changed files with 18 additions and 1 deletions
--- a/.env.example
+++ b/.env.example
@ -0,0 +1,3 @@
+local=true
+admin_ip=127.0.0.1
+cookie=s%3A...
--- a/README.md
+++ b/README.md
@ -1 +1,15 @@
-# faucet
+# Woodburn Faucet
+A simple faucet for Handshake domains
+
+Running on [faucet.woodburn.au](https://faucet.woodburn.au)
+
+## Docker deployment
+```
+docker run -d \
+  --name=faucet \
+  -e admin_ip=<your-IP> \
+  -e cookie=<your-nb-main-cookie>
+  -p 5000:5000 \
+  git.woodburn.au/nathanwoodburn/faucet:latest
+
+```