Create README.md

README.md

@@ -0,0 +1,28 @@
+# Yireo HyvaCheckoutUtils
+**Magento 2 module to make it easier to register a custom `tailwind.config.js` file of your own module in the global Hyvä Themes Tailwind configuration**
+
+### Background
+Hyvä Themes offers a Magento 2 CLI command `hyva:config:generate` to allow building a file `app/etc/hyva-themes.json` that again is used in modern-day Tailwind configuration of Hyvä-based themes. However, to extend this, one must add a custom observer to the module, which leads to a lot of code duplication across your modules. This module aims to simplify this. It offers an observer following the official Hyvä documentation. 
+
+However, this observer automatically registers any module that has a prefix `Yireo_` or `YireoTraining_` (it works for me). And it allows for extending things with a DI plugin.
+
+### Usage
+Add this module as a dependency to your `composer.json` file and `etc/module.xml` file.
+
+Next, add the following DI configuration to your module its `etc/di.xml` file (assuming here that `Foo_Bar` is the name of your own module):
+```xml
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Yireo\HyvaCheckoutUtils\Observer\RegisterModuleForHyvaConfig">
+        <arguments>
+            <argument name="moduleNames" xsi:type="array">
+                <item name="Foo_Bar" xsi:type="object">Foo_Bar</item>
+            </argument>
+        </arguments>
+    </type>
+</config>
+```
+
+### Todo
+Rename this module from `Yireo_HyvaCheckoutUtils` to something like `Yireo_HyvaThemesAutoRegistration` because this has zero to do with the checkout.