From 16c4090c31abca2adc4b5394c4bae7f4f23e1dda Mon Sep 17 00:00:00 2001
From: Thomas E Lackey <telackey@noreply.git.vdb.to>
Date: Thu, 17 Aug 2023 22:33:59 +0000
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 8b13789..a4a3658 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
+# keycloak-reg-api
 
+Simple API for self-registration of Keycloak accounts that use API keys.
+
+## Building
+
+### Local
+
+```
+$ yarn install
+$ export CERC_KCUSERREG_API_URL=http://keycloak:8080/auth
+$ export CERC_KCUSERREG_REG_PW=MySecretKeycloakApiPassword
+$ yarn dev
+```
+
+### Docker
+
+```
+$ docker build -t cerc/keycloak-reg-api:local .
+$ docker run \
+    -e CERC_KCUSERREG_API_URL=http://keycloak:8080/auth \
+    -e CERC_KCUSERREG_REG_PW=MySecretKeycloakApiPassword \
+    -p 9292 cerc/keycloak-reg-api:local
+```
\ No newline at end of file