From 2ff3e64f711f80eeaba3b37879761580f4dc322e Mon Sep 17 00:00:00 2001 From: abhigyanpatwari Date: Tue, 28 Apr 2026 17:15:03 +0530 Subject: [PATCH] docs(readme): fix misleading Web UI section (#1110) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The "Web UI (browser-based)" section described an old client-side architecture. Today gitnexus.vercel.app is a thin frontend that auto-connects to a local `gitnexus serve` backend — there is no ZIP drag-and-drop and no fully self-contained mode. - Drop "No server, no install" claim - Replace "drag & drop a ZIP" tagline with the actual onboarding step - Add the missing `gitnexus serve` step to the local-dev block Closes #1110 Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a17737d32..ade7a4879 100644 --- a/README.md +++ b/README.md @@ -324,19 +324,21 @@ flowchart TD ## Web UI (browser-based) -A fully client-side graph explorer and AI chat. No server, no install — your code never leaves the browser. +A client-side graph explorer and AI chat — your code never leaves your machine. -**Try it now:** [gitnexus.vercel.app](https://gitnexus.vercel.app) — drag & drop a ZIP and start exploring. +**Try it now:** [gitnexus.vercel.app](https://gitnexus.vercel.app) — run `npx gitnexus@latest serve` locally and the page auto-connects to your local backend. gitnexus_img -Or run locally: +Or run the frontend locally: ```bash git clone https://github.com/abhigyanpatwari/gitnexus.git cd gitnexus/gitnexus-shared && npm install && npm run build cd ../gitnexus-web && npm install npm run dev +# Then in another terminal, start the backend the frontend connects to: +npx gitnexus@latest serve ``` ## Docker