Add documentation about swc plugins feature

Karibash · Mar 30, 2022 · 8b587da · 8b587da
1 parent 541b86e
commit 8b587da
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.changeset/nice-rules-exercise.md b/.changeset/nice-rules-exercise.md
@@ -0,0 +1,5 @@
+---
+"storybook-addon-swc": patch
+---
+
+Add documentation about swc plugins feature
diff --git a/README.md b/README.md
@@ -62,6 +62,29 @@ module.exports = {
 | `swcLoaderOptions` | Options for swc loader.                                                                     | [object](https://swc.rs/docs/configuration/compilation)  | [see](https://github.com/Karibash/storybook-addon-swc/blob/master/src/index.ts#L19-L32) |
 | `swcMinifyOptions` | Options for swc minify.                                                                     | [object](https://swc.rs/docs/configuration/minification) | [see](https://github.com/Karibash/storybook-addon-swc/blob/master/src/index.ts#L33-L37) |
 
+### SWC Plugins
+
+The SWC plugins feature is still experimental, but can be used by changing the settings as follows.
+
+```js
+module.exports = {
+  addons: [
+    {
+      name: 'storybook-addon-swc',
+      options: {
+        swcLoaderOptions: {
+          jsc: {
+            experimental: {
+              plugins: [['plugin-name', {}]],
+            },
+          },
+        },
+      },
+    },
+  ],
+};
+```
+
 ## 🎓 Alternative
 
 ### [storybook-addon-turbo-build](https://github.com/pocka/storybook-addon-turbo-build)