docs: updated README.md

unplugin · May 30, 2023 · 73878c0 · 73878c0
1 parent 128e395
commit 73878c0
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/README.ZH-CN.md b/README.ZH-CN.md
@@ -28,6 +28,9 @@ pnpm add unplugin-vue-ce -D
 ```
 
 ## Usage
+
+> Tips: 你需要开启 `@vitejs/plugin-vue` 的 `customElement` 选项
+
 <details>
 <summary>Vite</summary>
 
@@ -39,7 +42,9 @@ import vue from '@vitejs/plugin-vue'
 import type { PluginOption } from 'vite'
 export default defineConfig({
   plugins: [
-    vue(),
+    vue({
+      customElement: true,
+    }),
     viteVueCE() as PluginOption,
   ],
 })

diff --git a/README.md b/README.md
@@ -28,6 +28,9 @@ pnpm add unplugin-vue-ce -D
 ```
 
 ## Usage
+
+> Tips: You need to enable the `customElement` option of `@vitejs/plugin-vue`
+
 <details>
 <summary>Vite</summary>
 

diff --git a/packages/sub-style/README.md b/packages/sub-style/README.md
@@ -24,6 +24,9 @@ pnpm add @unplugin-vue-ce/sub-style
 ```
 
 ## Usage
+
+> Tips: You need to enable the `customElement` option of `@vitejs/plugin-vue`
+
 <details>
 <summary>Vite</summary>