sql-kite 1.0.4 → 1.0.6

package/README.md

@@ -10,13 +10,17 @@
 
 <p align="center">
   <strong>Version-controlled SQLite for local development.</strong>
-</p>init
+</p>
 
 <p align="center">
   Branch your database. Inspect every change. Recover instantly.<br/>
   <b>No cloud • No accounts • No telemetry</b>
 </p>
 
+<p align="center">
+  <code>npm install -g sql-kite</code>
+</p>
+
 ---
 
 <p align="center">
@@ -140,22 +144,6 @@ A clean local interface for:
 
 ---
 
-## Screenshots
-
-### SQL Editor
-
-Execute queries, save templates, and export results with full SQL syntax highlighting.
-
-![SQL Editor](../../screenshots/sql-editor.png)
-
-### Database Schema Viewer
-
-Browse tables, inspect columns, constraints, indexes, and relationships in a clean interface.
-
-![Database Schema](../../screenshots/database-schema.png)
-
----
-
 ## Zero-Cloud Architecture
 
 SQL Kite runs **entirely on your machine**.
@@ -179,22 +167,54 @@ SQL Kite runs **entirely on your machine**.
 * Node.js 18+
 * npm
 
-### Install Globally (Recommended)
+### Option 1: Global Installation (Recommended)
 
-Install SQL Kite globally to use it from anywhere:
+Install globally to use `sql-kite` commands from anywhere:
 
 ```bash
 npm install -g sql-kite
 ```
 
-After installation, you can use `sql-kite` commands directly:
+**Usage after global installation:**
 
 ```bash
 sql-kite new my-db
 sql-kite start my-db
+sql-kite list
+```
+
+### Option 2: Local Installation
+
+Install locally in your project:
+
+```bash
+npm install sql-kite
+```
+
+**Usage after local installation:**
+
+Add this script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "sql-kite": "sql-kite"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run sql-kite new my-db
+npm run sql-kite start my-db
+npm run sql-kite list
+npm run sql-kite import ./database.db
 ```
 
-> **Note:** Use global installation (`-g` flag) for CLI tools. After installing globally, run commands directly as `sql-kite <command>`, not `npm run sql-kite <command>`.
+---
+
+> **Recommendation:** Use global installation for CLI tools to avoid typing `npm run` every time.
 
 ---
 
@@ -265,6 +285,12 @@ lib/database/
   └── engine.local.js
 ```
 
+| File | Purpose |
+|---|---|
+| `index.js` | Auto-switches between dev and production engines |
+| `engine.dev.js` | HTTP client that queries the SQL-Kite server |
+| `engine.local.js` | Local SQLite via expo-sqlite for production |
+
 **2) Use in your app:**
 
 ```javascript
@@ -273,6 +299,29 @@ import { runQuery } from '@/lib/database';
 const users = await runQuery("SELECT * FROM users WHERE active = ?", [1]);
 ```
 
+### How Dev/Prod Switching Works
+
+The switching is **fully automatic** — the user does not need to manually toggle anything.
+
+```javascript
+const isDev = typeof __DEV__ !== 'undefined' ? __DEV__ : process.env.NODE_ENV === 'development';
+```
+
+**Detection order:**
+1. **Expo's `__DEV__` global** — automatically `true` in dev builds, `false` in production
+2. **Fallback:** `process.env.NODE_ENV === 'development'`
+
+| Environment | Engine Used | How it works |
+|---|---|---|
+| Development (`isDev = true`) | `engine.dev.js` | Queries go to SQL-Kite server via HTTP |
+| Production (`isDev = false`) | `engine.local.js` | Queries run locally via expo-sqlite |
+
+### Port Configuration (Dev Mode)
+
+The dev engine connects to the SQL-Kite server using:
+- `SQL_KITE_PORT` environment variable (if set)
+- Default port `3000` (editable in the generated `engine.dev.js`)
+
 ### Two Workflow Modes
 
 **Development Mode:**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sql-kite",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "SQL-Kite CLI — Local-first SQLite workspace with branches, migrations and snapshots.",
   "type": "module",
   "preferGlobal": true,