DOCS

Author: mhsdesign

Readme.md

@@ -2,6 +2,9 @@
 
 Yet another css modules plugin for esbuild? Pleaso no?
 
+<details>
+<summary>Read more about the "why"...</summary>
+
 Yes sorry, i know there are a few implementions already out there:
 
 - @asn.aeb/esbuild-css-modules-plugin
@@ -18,3 +21,41 @@ The above implementations mostly rely on `post-cssmodules` and thus dont sucessf
 With one exception: `esbuild-css-modules-plugin`, this plugin uses also lightningcss as its core, but doesnt support composes yet and due to a more complex inject feature it is a bit more complex. I discussed with the maintainer if we would want to merge our two packages but due to limited time and different usecases (https://github.com/indooorsman/esbuild-css-modules-plugin/issues/53) im here to present my super simple implemented css module plugin for esbuild.
 
 The plugin is already tested (on linux and mac) and used to build the following bigger project https://github.com/neos/neos-ui with around 100 css modules - it is inlined in the project though to reduce dependencies and maintaining burdens for now.
+</details>
+
+## Usage
+
+```js
+build({
+    ...,
+    plugins: [
+        cssModules(
+            {
+                // add your own or other plugins in the "visitor" section see
+                // https://lightningcss.dev/transforms.html
+                // visitor: myLightningcssPlugin(),
+                targets: {
+                    chrome: 80 // aligns somewhat to es2020
+                },
+                drafts: {
+                    nesting: true
+                },
+                // pattern: 'my-company-[name]-[hash]-[local]'
+            }
+        )
+    ]
+})
+```
+
+for further details look into: https://lightningcss.dev/css-modules.html
+
+## Advanced options
+### `includeFilter` and `excludeFilter`
+These options only exist for odd / legacy codebases.
+Normally it is asummed that your css module files end with `.module.css`.
+If this is not the case, and they end with `.css` while you still want to exclude certain normal css from beeing treated as css module you can leverage the two filters like this:
+
+```js
+includeFilter: /\.css$/,
+excludeFilter: /@fortawesome\/fontawesome-svg-core\/|my-normal-css-file\.css|normalize\.css/,
+```