From 53599613ee5c360544123727bc0f67d3e5249ec6 Mon Sep 17 00:00:00 2001 From: Nicolas Varrot Date: Wed, 11 Feb 2026 13:46:21 +0000 Subject: [PATCH] docs: update README for runtime login and i18n features --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3c7dd1b..59448b0 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ - 📝 **Markdown rendering** — full GFM support with code highlighting - 📎 **File upload** — attach files to your messages - ⚡ **Streaming responses** — watch the AI think in real-time +- 🔐 **Runtime login** — enter gateway credentials at runtime, no secrets in the build +- 🌐 **i18n support** — English and French, configurable via `VITE_LOCALE` ## 🚀 Quick Start @@ -34,11 +36,11 @@ npm install cp .env.example .env ``` -Edit `.env` with your gateway details: +Optionally edit `.env` to pre-fill the gateway URL: ```env VITE_GATEWAY_WS_URL=ws://localhost:18789 -VITE_GATEWAY_TOKEN=your-gateway-token-here +VITE_LOCALE=en # or "fr" for French UI ``` Start the dev server: @@ -58,10 +60,14 @@ Or serve the `dist/` folder with nginx, Caddy, or any static file server. ## ⚙️ Configuration +All configuration is optional — credentials are entered at runtime via the login screen. + | Variable | Description | Default | |---|---|---| -| `VITE_GATEWAY_WS_URL` | WebSocket URL of the OpenClaw gateway | `ws://:18789` | -| `VITE_GATEWAY_TOKEN` | Authentication token for the gateway | *(required)* | +| `VITE_GATEWAY_WS_URL` | Pre-fill the gateway URL on the login screen | `ws://:18789` | +| `VITE_LOCALE` | UI language (`en` or `fr`) | `en` | + +> **Note:** The gateway token is entered at runtime and stored in `localStorage` — it is never baked into the build. ## 🛠 Tech Stack