docs: update

unplugin · Nov 1, 2023 · 8c3acf4 · 8c3acf4
1 parent 555c2d6
commit 8c3acf4
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -41,9 +41,29 @@ import TurboConsole from "vite-plugin-turbo-console";
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [TurboConsole()],
+  plugins: [TurboConsole({
+    /* options here */
+  })],
 });
 ```
+**options**
+```ts
+interface TurboConsoleOptions {
+  /**
+   * Add a string prefix to the console log.
+   */
+  prefix?: string
+  /**
+   * Add a string suffix to the console log.
+   */
+  suffix?: string
+  /**
+   * Whether to disable the launch editor feature.
+   * default: false
+   */
+  disableLaunchEditor?: boolean
+}
+```
 
 ## ❤️ Credits
 Inspired by