From 4b3b0487545ffafe90349294333325195a62c3fe Mon Sep 17 00:00:00 2001
From: Ferdinand Kuhl <f.kuhl@digital-competence.de>
Date: Thu, 28 Nov 2024 17:25:02 +0100
Subject: [PATCH] adding some information and legal stuff

---
 LICENSE       | 19 +++++++++++++++++++
 README.md     | 19 +++++++++++++++++++
 composer.json |  5 +++++
 3 files changed, 43 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..7c439ae
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2024 Ferdinand Kuhl <f.kuhl@digital-competence.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b91cdcf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# DigiComp.FlowMaintenanceMode
+
+This package assists in presenting each visitor of your system a page showing working on maintenance.
+
+It allows you to use usual error page rendering for that purpose - the idea is, that those layouts, should exist anyway.
+
+If you want to bypass the maintenance mode, you can do so by configuring a cookie based exception:
+
+```yaml
+DigiComp:
+  FlowMaintenanceMode:
+    allowCookie:
+      name: name
+      value: value
+```
+
+That would allow you to bypass the maintenance answer, if you had a cookie named 'name' with a value of 'value'. If you set 'value' to `null` only the name is matched.
+
+You can extend the exception behavior, by implementing the `AllowModuleInterface` and add it to `DigiComp.FlowMaintenanceMode.allowModules`. This list handled by positional array sorter. You can use position keys to order them, or set their value to null to exclude them from being used.
diff --git a/composer.json b/composer.json
index 4e92536..aa57ae7 100644
--- a/composer.json
+++ b/composer.json
@@ -11,10 +11,15 @@
       "DigiComp\\FlowMaintenanceMode\\": "Classes"
     }
   },
+  "homepage": "https://git.digital-competence.de/Packages/DigiComp.FlowMaintenanceMode",
+  "license": "MIT",
   "extra": {
     "neos": {
       "package-key": "DigiComp.FlowMaintenanceMode"
     },
+    "branch-alias": {
+      "dev-develop": "1.0.x-dev"
+    },
     "applied-flow-migrations": [
     ]
   }