From 06be17b5bd4ad6b519d323adfb6668d16d2faf39 Mon Sep 17 00:00:00 2001
From: Ferdinand Kuhl <f.kuhl@digital-competence.de>
Date: Thu, 26 Aug 2021 15:19:06 +0200
Subject: [PATCH] Adding small explanation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..781bc71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+DigiComp.FlowSessionLock
+------------------------
+
+By default the session established by Flow is not "protected" in any way.
+This package restricts every request to load the session only, if there are no other requests having it in access currently.
+It allows to set custom pointcut which will set the session in "ReadOnly" mode, which allows concurrent requests to read, but disallows the current request to write the session.
+
+If you want to allow concurrent access somewhere, you can add your trigger pointcut in Settings.yaml like such:
+  
+    DigiComp:
+      FlowSessionLock:
+        readOnlyExpressions:
+          'AcmeLock': 'method(Acme/SuperPackage/Controller/ConcurrentController->concurrentAction())'