From 96d25c7fdf15b2caad9a37fea7c38c5b20ed1483 Mon Sep 17 00:00:00 2001
From: Mark Tearle <mtearle@ucc.asn.au>
Date: Sat, 16 Jan 2021 23:18:55 +0800
Subject: [PATCH] Scope out Quovadis API in README

---
 README.md                        | 61 +++++++++++++++++++++++++++++++-
 scripts/certbot-hook-quovadis.sh |  0
 scripts/register-apikey.sh       |  0
 3 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 scripts/certbot-hook-quovadis.sh
 create mode 100644 scripts/register-apikey.sh

diff --git a/README.md b/README.md
index af22f1b..e6751eb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,62 @@
 # quovadis
 
-REST API to assist with ACME challenges
\ No newline at end of file
+REST API to assist with ACME challenges
+
+## API
+
+### Documentation
+
+GET / 
+
+### Register User
+
+POST /register
+
+Params:
+* UCC username
+
+Will email to your UCC email address an API key to use with the service
+
+### Update API key
+
+POST /update-api-key
+
+Params:
+* UCC username
+* Old API key
+* New API key
+
+Will update API key
+
+Will email to your UCC email address noting that the API key has been updated
+
+### Update Challenge
+
+POST /update-challenge
+
+Params:
+
+* UCC username
+* API key
+* Challenge Handle
+* Challenge TXT
+
+Will update the DNS TXT record at 
+
+<ucc username>-<challenge handle>.quovadis.ucc.asn.au 
+
+to the contents of Challenge TXT
+
+
+## Use
+
+This is intended to be used with the certbot hook scripts included alongside this code
+
+register-apikey.sh
+
+certbot-hook-quovadis.sh
+
+
+## Author
+
+Mark Tearle <mtearle@ucc.asn.au>
diff --git a/scripts/certbot-hook-quovadis.sh b/scripts/certbot-hook-quovadis.sh
new file mode 100644
index 0000000..e69de29
diff --git a/scripts/register-apikey.sh b/scripts/register-apikey.sh
new file mode 100644
index 0000000..e69de29
-- 
GitLab