diff --git a/README.md b/README.md index 3b5e30d..f816e2e 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,3 @@ -# Vynte Connect for Windows +# Vynte Connect -Vynte Connect for Windows is a tray wrapper around the bundled `netbird.exe` CLI for `https://vpn.vyntehome.com`. - -It exposes the same basic flow as the macOS app: - -- Connect to `vpn.vyntehome.com` -- Disconnect the tunnel -- Log out so the next connect registers with NetBird again -- Show gateway, internal IP, peer count, and connection state - -## Build - -Place the Windows NetBird runtime files in `resources/` before packaging: - -- `resources/netbird.exe` -- `resources/wintun.dll` - -```powershell -npm install -npm run package:win -``` - -The packaged app is written to `dist/Vynte Connect-win32-x64/`, and a portable zip is written to `dist/Vynte-Connect-Windows-x64.zip`. - -This build intentionally creates a portable Windows app without stamping Windows executable metadata, so it can be built from macOS without Wine. - -## Runtime behavior - -On first connect, the app uses Windows UAC to install/start the bundled Vynte network helper service: - -```powershell -netbird.exe service install --management-url https://vpn.vyntehome.com --admin-url https://vpn.vyntehome.com -netbird.exe service start -``` - -Then it runs: - -```powershell -netbird.exe up --management-url https://vpn.vyntehome.com --admin-url https://vpn.vyntehome.com -``` +Vynte Connect is a tray wrapper around the bundled netbird CLI for `https://vpn.vyntehome.com`.