Add Vite usage example (#99)

surrealdb · Aug 7, 2024 · b4d33e6 · b4d33e6
1 parent 805873f
commit b4d33e6
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -56,3 +56,21 @@ await db.connect("indxdb://demo");
 
 // Now use the JavaScript SDK as normal.
 ```
+
+## Usage with Vite
+
+When using [Vite](https://vitejs.dev/) the following configuration is recommended to be placed in your `vite.config.ts`
+
+```js
+optimizeDeps: {
+    exclude: ['surrealdb.wasm', 'surrealql.wasm'],
+    esbuildOptions: {
+        target: 'esnext',
+    },
+},
+esbuild: {
+    supported: {
+        'top-level-await': true
+    },
+}
+```