@fui-org/fui-cli 1.1.0 → 1.2.0

package/README.md

@@ -4,48 +4,24 @@ A command-line tool for the FUI low-code platform: projects, modules, components
 
 ## Install
 
-### 1. Install Bun
+### 1. Install fui
 
-`fui` runs on [Bun](https://bun.com) 1.4 or later. Skip this step if `bun --version` already prints 1.4 or later.
-
-macOS and Linux:
-
-```bash
-curl -fsSL https://bun.sh/install | bash
-```
-
-On macOS you can use Homebrew instead:
+Needs [Node.js](https://nodejs.org) 22 or later (`node --version`).
 
 ```bash
-brew install oven-sh/bun/bun
-```
-
-Windows (PowerShell):
-
-```powershell
-powershell -c "irm bun.sh/install.ps1 | iex"
-```
-
-Open a new terminal so `PATH` picks up Bun, then check it:
-
-```bash
-bun --version
+npm install -g @fui-org/fui-cli
+fui --version
 ```
 
-To upgrade an older Bun, run `bun upgrade`.
+### Or install with Bun
 
-### 2. Install fui
+If you use [Bun](https://bun.com) as your package manager, install fui with it instead. fui still runs on Node.js.
 
 ```bash
 bun add -g @fui-org/fui-cli
-fui --version
 ```
 
-This puts `fui` on your `PATH`, in `~/.bun/bin` on macOS and Linux and in `%USERPROFILE%\.bun\bin` on Windows.
-
-Already use Node.js 22 or later? `npm install -g @fui-org/fui-cli` works too. Also install Node.js 22+ on a Bun-only machine, because `fui` starts through `node`. Postgres and MySQL connections need Bun.
-
-### 3. Set up
+### 2. Set up
 
 Ask your FUI administrator for the API address and your API token, then:
 
@@ -60,9 +36,11 @@ The token is read from stdin, so it never lands in your shell history. `fui conf
 For real-browser checks (`fui module simulate --render`, `fui component preview`), install Playwright once:
 
 ```bash
-bun add -g playwright && bunx playwright install chromium
+npm install -g playwright && npx playwright install chromium
 ```
 
+Installed fui with Bun? Install Playwright the same way, so fui finds it: `bun add -g playwright && bunx playwright install chromium`.
+
 ## Updates
 
 `fui` updates itself in the background, at most once an hour, and prints one line after an update. `fui update` updates now, and `fui update --check` only reports. Turn it off with `fui config set auto-update off`.
@@ -115,16 +93,16 @@ Secrets are read only from stdin (`-`) or from an env var (`--*-env VAR`):
 
 ```bash
 printf %s "$TOKEN" | fui db add docs -p my-project --token - --api-domain tapi.example.edu.vn
-fui db add local -p demo --conn-env PG_URL
+fui db add local -p demo --conn-env SQLITE_URL
 fui db list
 ```
 
-A connection is an MSSQL string (through tAPI) or a `postgres://`, `mysql://` or `sqlite://` URL.
+A connection is an MSSQL string (through tAPI) or a `sqlite://` URL.
 
 ## Uninstall
 
 ```bash
-bun remove -g @fui-org/fui-cli
+npm uninstall -g @fui-org/fui-cli
 ```
 
-With npm: `npm uninstall -g @fui-org/fui-cli`.
+Installed with Bun: `bun remove -g @fui-org/fui-cli`.