From bf4f933108c903b2d7756e4f736f23e88fa2bbfe Mon Sep 17 00:00:00 2001
From: Julian Rother <julianr@fsmpi.rwth-aachen.de>
Date: Mon, 5 Oct 2020 23:10:13 +0200
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f3a94ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+OAuth2 Proxy for Single-Sign-On with Nginx
+==========================================
+
+This application implements a generic OAuth2 client for easy integration of
+NGINX into an OAuth2-based Single-Sign-On system. It is bound to a single
+OAuth2 server (urls defined in config) and -- apart from a session cookie --
+stateless. OAuth2 client id, secret and redirect URI are passed from the
+integrating NGINX to the proxy in HTTP headers.
+
+See testapp for an example setup.
-- 
GitLab