From d60aff639bedd468fbf7c793a2fcb8386689611f Mon Sep 17 00:00:00 2001
From: Richard Stephens <richard@richst.dev>
Date: Sun, 26 Feb 2023 23:46:07 +0100
Subject: [PATCH] add README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a9e62d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Authenticating Reverse Proxy
+============================
+
+This is a simple reverse proxy that can be used to expose a
+service using HTTP Basic authentication and GitHub Personal Access Tokens as an auth backend.
+
+Other auth methods may be supported in the future.
+
+The org token parameter is optional, but without it, only users who have their org membership publicly visible will be
+able to login.
+
+Usage:
+
+```shell
+docker run -it -e TARGET=http://example.com \
+    -e AUTH_METHOD=GH_BASIC \
+    -e GH_ORG=your-org \
+    -e GH_ORG_TOKEN=ghp_XXXXX \
+    -e BIND=0.0.0.0:8080 \
+    -p 8080:8080 \
+    ghcr.io/richardstephens/authenticating-reverse-proxy:latest
+```
\ No newline at end of file