From ca21c677a10267906c4c0cc03e8be277395a4ee2 Mon Sep 17 00:00:00 2001
From: Viacheslav Slinko <me@vslinko.com>
Date: Mon, 1 Apr 2024 19:59:59 +0300
Subject: [PATCH] Added README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eefca09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Secret Auth
+
+Authorise requests by secret cookie
+
+## Configuration
+
+```yaml
+# Static configuration
+
+experimental:
+  plugins:
+    example:
+      moduleName: github.com/vslinko/secret-auth
+      version: v0.1.0
+```
+
+```yaml
+# Dynamic configuration
+
+http:
+  routers:
+    my-router:
+      rule: host(`demo.localhost`)
+      service: service-foo
+      entryPoints:
+        - web
+      middlewares:
+        - secret-auth
+
+  services:
+    service-foo:
+      loadBalancer:
+        servers:
+          - url: http://127.0.0.1:5000
+
+  middlewares:
+    secret-auth:
+      plugin:
+        secret-auth:
+          cookieName: myCookie
+          secretKey: mySecretKey
+```