Add readme.

Author: rkistner

README.md

@@ -0,0 +1,21 @@
+# sqlite-js
+
+Universal SQLite APIs for JavaScript.
+
+## @sqlite-js/driver
+
+This is a universal driver API and utilities for implementing drivers.
+
+The APIs here are low-level, and should not be used directly in most use cases.
+
+### @sqlite-js/driver/node
+
+This is a driver implementation for NodeJS based on the experimental `node:sqlite` package.
+
+## @sqlite-js/better-sqlite3-driver
+
+This is a driver implementation for NodeJS implementation based `better-sqlite3`.
+
+## @sqlite-js/api
+
+This contains a higher-level API, including transaction support.

packages/api/README.md

@@ -0,0 +1,11 @@
+# @sqlite-js/api
+
+This provides higher-level SQLite APIs, built on the lower-level driver APIs.
+
+This supports:
+
+1. Simple asynchronous queries.
+2. Transactions.
+3. Connection-level locking.
+4. Pipelining operations.
+5. Re-using prepared statements.

packages/better-sqlite3-driver/README.md

@@ -0,0 +1,17 @@
+# @sqlite-js/better-sqlite3-driver
+
+This contains a driver implementation based on better-sqlite3.
+
+There are two main options for using the driver:
+
+```ts
+const driver = BetterSqliteDriver.open(path);
+```
+
+This opens a connection pool using worker_threads, giving asynchronous I/O.
+
+```ts
+const driver = BetterSqliteDriver.openInProcess(path);
+```
+
+This opens a single in-process connection, with blocking I/O. This can give lower latency and higher throughput, at the cost of blocking the process and not supporting concurrent operations.

packages/driver-tests/README.md

@@ -0,0 +1,5 @@
+# @sqlite-js/driver-tests
+
+This package contains a standard test suite to test any driver.
+
+The tests can run under vitest or mocha.

packages/driver/README.md

@@ -0,0 +1,35 @@
+# @sqlite-js/driver
+
+This contains a driver API, as well as driver utilities.
+
+## @sqlite-js/driver
+
+The main export contains the driver API. The API is centered around connection pooling and prepared statements.
+
+## @sqlite-js/driver/node
+
+This is a driver implementation for NodeJS based on the experimental `node:sqlite` package.
+
+There are two main options for using the driver:
+
+```ts
+const driver = NodeSqliteDriver.open(path);
+```
+
+This opens a connection pool using worker_threads, giving asynchronous I/O.
+
+```ts
+const driver = NodeSqliteDriver.openInProcess(path);
+```
+
+This opens a single in-process connection, with blocking I/O. This can give lower latency and higher throughput, at the cost of blocking the process and not supporting concurrent operations.
+
+## @sqlite-js/driver/util
+
+This contains utilities for driver implementations, such as connection pooling.
+
+## @sqlite-js/driver/worker_threads
+
+This contains utilities for running a driver implementation in a NodeJS worker_thread, to get non-blocking I/O.
+
+The APIs here are not stable, and expected to change.

packages/driver/package.json

@@ -18,11 +18,7 @@
   "keywords": [],
   "author": "",
   "license": "MIT",
-  "dependencies": {
-    "vitest": "^2.0.5",
-    "mocha": "^10.7.3",
-    "@sqlite-js/driver": "workspace:^"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@types/node": "^22.3.0",
     "typescript": "^5.5.4"