Add auto-story-generator configuration for React and update package k…

…eywords

README.md

@@ -6,7 +6,47 @@
 Automatic real-time story file generation from React, Vue, and Lit component files
 
 ## Getting Started
-1. Install the package
+### 1. Install the package
 ```bash
 npm i @takuma-ru/auto-story-generator
 ```
+
+### 2. Add config
+Add settings to main.ts in Storybook (`./storybook/main.ts`)
+
+For `React`, `Vite`
+```ts
+import type { StorybookConfig } from "@storybook/react-vite";
+
+import { mergeConfig } from "vite";
+
+import autoStoryGenerator from "@takuma-ru/auto-story-generator";
+
+const config: StorybookConfig = {
+  viteFinal: async (config) =>
+    mergeConfig(config, {
+      plugins: [
+        autoStoryGenerator.vite({
+          preset: "react",
+          imports: ["**/src/components/**/*.tsx"],
+        }),
+      ],
+    }),
+};
+
+export default config;
+```
+
+## Supported Frameworks
+> ✅: Supported
+> 🚧: Work in progress
+> ❌: Not supported
+> 📝: Not yet implemented
+
+| Framework | Supported |
+| --------- | --------- |
+| React     | ✅         |
+| Vue       | 🚧         |
+| Lit       | ✅         |
+| Angular   | ❌         |
+| Svelte    | 📝         |

packages/auto-story-generator/package.json

@@ -39,7 +39,17 @@
     "publish:patch-beta": "pnpm build && pnpm dlx release-it patch --preRelease=beta --ci",
     "publish:prerelease": "pnpm build && pnpm dlx release-it prerelease --ci"
   },
-  "keywords": [],
+  "keywords": [
+    "storybook",
+    "generator",
+    "auto",
+    "react",
+    "vue",
+    "lit",
+    "storybook-addon",
+    "storybook-addon-generator",
+    "storybook-addon-auto-story-generator"
+  ],
   "author": "takuma-ru <[email protected]> (https://github.com/takuma-ru/)",
   "license": "MIT",
   "repository": {
@@ -50,7 +60,7 @@
     "url": "https://github.com/takuma-ru/auto-story-generator/issues",
     "email": "[email protected]"
   },
-  "homepage": "",
+  "homepage": "https://auto-story-generator.takumaru.dev",
   "dependencies": {
     "consola": "^3.2.3",
     "magicast": "^0.3.2",