adding minimal documentation and package meta information

2024-05-30 15:23:04 +02:00 · 2024-05-30 15:23:04 +02:00 · e303f86640
commit e303f86640
parent 193d9b925a
2 changed files with 29 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,13 @@
+# DigiComp.FluidCurrentControllerExpression
+
+This extends the fluid language with an expression to allow you to access values of the current action request.
+
+```html
+<html>
+    <title>Welcome to {#currentController.name} {#currentController.actionName}</title>
+</html>
+```
+
+The pattern is `{#currentController.PROPERTY_OF_ACTIONREQUEST}` - all properties are possible. To avoid duplicated "controller" in the expression you are allowed to omit them (even if it works, if you do not).
+
+It is really helpful if you try to generalize partials - being an expression, it is not depending on any aliased namespace, which might change in deeper structures.
--- a/composer.json
+++ b/composer.json
@ -16,5 +16,20 @@
        "psr-4": {
            "DigiComp\\FluidCurrentControllerExpression\\": "Classes/"
        }
-    }
+    },
+    "authors": [
+        {
+            "name": "Ferdinand Kuhl",
+            "email": "f.kuhl@digital-competence.de",
+            "homepage": "https://www.digital-competence.de",
+            "role": "Developer"
+        }
+    ],
+    "license": "MIT",
+    "homepage": "https://git.digital-competence.de/Packages/DigiComp.FluidCurrentControllerExpression",
+    "keywords": [
+        "Neos",
+        "Flow",
+        "fluid"
+    ]
 }