web-sqlite-js 0.0.2-beta → 0.0.3

package/README.md

@@ -1,8 +1,10 @@
-# web-sqlite-js
+ <h1 align="center">web-sqlite-js</h1>
+<p align="center"> <img src="docs/public/web-sqlite-js.gif" width="400px" />
+</p>
 
-Enables direct use of SQLite in the web browser with reliable local data persistence via OPFS (Origin Private File System).
+`web-sqlite-js` gives web developers an out-of-the-box way to run SQLite directly in the browser and keep data persisted on the client via OPFS (Origin Private File System).
 
-It runs SQLite in a Web Worker to avoid blocking the main thread and handles all synchronization automatically, providing a simple, Promise-based API.
+Developers only need to install and configure the http request header to use it directly, which is quite friendly.
 
 ## Features
 
@@ -18,19 +20,15 @@ It runs SQLite in a Web Worker to avoid blocking the main thread and handles all
 npm install web-sqlite-js
 ```
 
-## ⚠️ Critical Configuration: COOP & COEP
+## Setup http headers
 
-To use `SharedArrayBuffer` (required by the SQLite WASM build), your server **must** serve the application with the following HTTP headers:
+This library high-performance dependencies `SharedArrayBuffer`, which requires your server to send the following HTTP headers:
 
 ```http
 Cross-Origin-Opener-Policy: same-origin
 Cross-Origin-Embedder-Policy: require-corp
 ```
 
-If these headers are missing, the database **will not start**.
-
-### Configuration Guides
-
 <details>
 <summary><strong>Vite</strong></summary>
 
@@ -155,7 +153,7 @@ If you are using an older webpack-based setup (like CRA `react-scripts`), you te
 
 ## Usage
 
-### Basic Query
+#### Basic Usage
 
 ```typescript
 import openDB from "web-sqlite-js";
@@ -197,7 +195,7 @@ console.log(users);
 await db.close();
 ```
 
-### Transactions
+#### Transactions
 
 Transactions are atomic. If any command inside the callback fails, the entire transaction is rolled back.
 
@@ -212,39 +210,3 @@ await db.transaction(async (tx) => {
     // throw new Error('Something went wrong');
 });
 ```
-
-### Multiple Connections
-
-You can open multiple connections to the same file. They will automatically synchronize access.
-
-```typescript
-const db1 = await openDB("shared-db");
-const db2 = await openDB("shared-db");
-
-await db1.exec("INSERT INTO items (name) VALUES (?)", ["Item 1"]);
-
-// db2 sees the change immediately after db1 finishes
-const items = await db2.query("SELECT * FROM items");
-```
-
-## API
-
-### `openDB(filename: string, options?: { debug?: boolean })`
-
-Opens a database connection. Returns a `DBInterface`.
-
-### `db.exec(sql: string, params?: any[] | Record<string, any>)`
-
-Executes a SQL statement (INSERT, UPDATE, DELETE, CREATE). Returns `{ changes, lastInsertRowid }`.
-
-### `db.query<T>(sql: string, params?: any[] | Record<string, any>)`
-
-Executes a SELECT statement. Returns an array of rows `T[]`.
-
-### `db.transaction<T>(callback: (tx: DBInterface) => Promise<T>)`
-
-Runs the callback inside a transaction (`BEGIN` ... `COMMIT`/`ROLLBACK`). The `tx` object provided to the callback has the same `exec` and `query` methods.
-
-### `db.close()`
-
-Closes the connection and terminates the worker.

package/package.json

@@ -1,7 +1,10 @@
 {
     "name": "web-sqlite-js",
-    "version": "0.0.2-beta",
-    "description": "Enables direct use of SQLite in the web browser with reliable local data persistence via OPFS.",
+    "version": "0.0.3",
+    "description": "web-sqlite-js gives web developers an out-of-the-box way to run SQLite directly in the browser and keep data persisted on the client via OPFS (Origin Private File System).",
+    "workspaces": [
+        "docs"
+    ],
     "type": "module",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -25,7 +28,7 @@
     "scripts": {
         "test": "npm run build && npm run lint && npm run test:unit && npm run test:e2e ",
         "test:unit": "vitest run --config vitest.unit.config.ts --coverage",
-        "http": "tsx scripts/http-service.ts ./ --port 8399",
+        "http": "tsx scripts/http-service.ts ./docs/.vitepress/dist --port 8399",
         "test:e2e": "vitest run --config vitest.e2e.config.ts",
         "test:debug": "vitest run --config vitest.e2e.config.ts --no-file-parallelism",
         "build": "vite build",
@@ -35,12 +38,15 @@
         "typecheck": "tsc --noEmit",
         "format": "prettier --ignore-path .gitignore --write .",
         "package:compress": "npm pack",
-        "package:publish": "npm run test && npm run build && npm publish --access public"
+        "package:publish": "npm run test && npm run build && npm publish --access public",
+        "docs:dev": "npm run dev --workspace=@web-sqlite-js/docs",
+        "docs:build": "npm run build --workspace=@web-sqlite-js/docs",
+        "docs:preview": "npm run preview --workspace=@web-sqlite-js/docs",
+        "docs:icons": "npm run icons --workspace=@web-sqlite-js/docs",
+        "docs:deploy": "cd docs && ./deploy.sh"
     },
     "files": [
-        "dist",
-        "LICENSE",
-        "README.md"
+        "dist"
     ],
     "devDependencies": {
         "@eslint/css": "^0.14.1",
@@ -73,4 +79,4 @@
         "url": "https://github.com/wuchuheng/web-sqlite-js/issues"
     },
     "homepage": "https://github.com/wuchuheng/web-sqlite-js#readme"
-}
+}