docs: readme

Author: webfansplz

README.md

@@ -50,6 +50,7 @@ export default defineConfig({
     createVuePlugin(),
     Inspector({
       vue: 2,
+      enabled: true
     }),
   ],
 })
@@ -63,7 +64,7 @@ import Vue from "@vitejs/plugin-vue"
 import Inspector from "vite-plugin-vue-inspector"
 
 export default defineConfig({
-  plugins: [Vue(), Inspector()],
+  plugins: [Vue(), Inspector({ enabled: true })],
 })
 ```
 
@@ -77,7 +78,10 @@ import Inspector from "vite-plugin-vue-inspector"
 export default defineNuxtConfig({
   vite: {
     plugins:[
-      Inspector()
+      Inspector({
+        appendTo: "entry.mjs",
+        enabled: true 
+      })
     ]
   }
 })
@@ -86,47 +90,54 @@ export default defineNuxtConfig({
 
 ### Options
 
-It provides an option which that controls the enable state. 
 
 ```ts
-
-import { defineConfig } from "vite"
-import Vue from "@vitejs/plugin-vue"
-import Inspector from "vite-plugin-vue-inspector"
-
-export default defineConfig({
-  plugins: [Vue(), Inspector({ enabled: false })],
-})
-```
-
-### [Nuxt3 Usage](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/example/nuxt)
-
-```ts
-// App.vue
-
-<template>
-  <inspector-overlay v-if="isDev"/>
-</template>
-
-<script lang="ts">
-
-import InspectorOverlay from "vite-plugin-vue-inspector/overlay.vue"
-export default {
-  name: "App",
-  components: {
-    InspectorOverlay
-  },
-  setup(){
-    return {
-      isDev: process.dev
-    }
-  }
+interface VitePluginInspectorOptions {
+  /**
+  * Vue version
+  * @default 3
+  */
+  vue?: 2 | 3
+
+  /**
+  * Default enable state
+  * @default false
+  */
+  enabled?: boolean
+
+  /**
+  * Define a combo key to toggle inspector
+  * @default 'control-shift' on windows, 'meta-shift' on other os
+  *
+  * any number of modifiers `control` `shift` `alt` `meta` followed by zero or one regular key, separated by -
+  * examples: control-shift, control-o, control-alt-s  meta-x control-meta
+  * Some keys have native behavior (e.g. alt-s opens history menu on firefox).
+  * To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.
+  */
+  toggleComboKey?: string
+
+  /**
+  * Toggle button visibility
+  * @default 'active'
+  */
+  toggleButtonVisibility?: "always" | "active" | "never"
+
+  /**
+  * Toggle button display position
+  * @default top-right
+  */
+  toggleButtonPos?: "top-right" | "top-left" | "bottom-right" | "bottom-left"
+
+  /**
+  * append an import to the module id ending with `appendTo` instead of adding a script into body
+  * useful for frameworks that do not support trannsformIndexHtml hook (e.g. Nuxt3)
+  *
+  * WARNING: only set this if you know exactly what it does.
+  */
+  appendTo?: string
 }
-
-</script>
 ```
 
-
 ### Example
 
 - [vue2](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/example/vue2)
@@ -185,13 +196,16 @@ export VUE_EDITOR=vim
 
 ## 💡 Notice
 
+- **From v1.0, `enabled` option default value changed from `true` to `false` .**
 - It only work in develop mode .
 - It does not currently support `Template Engine (e.g. pug)` .
 
-## 🌸 Thanks
+## 🌸 Credits
 
 This project is inspired by [react-dev-inspector](https://github.com/zthxxx/react-dev-inspector) .
 
+Partially implementation is inspired by [vite-plugin-svelte-inspector](https://github.com/sveltejs/vite-plugin-svelte/tree/main/packages/vite-plugin-svelte/src/ui/inspector) .
+
 ## 🤖️ Analysis of Theory
 
 [Chinese] [点击页面元素,这个Vite插件帮我打开了Vue组件](https://juejin.cn/post/7077347158545924127)

src/index.ts

@@ -22,7 +22,7 @@ export interface VitePluginInspectorOptions {
 
   /**
   * Default enable state
-  * @default true
+  * @default false
   */
   enabled?: boolean