Add a short project README.

Document what the app does, how to run it, and the main UI actions so the repo is usable without reading the full design spec.
This commit is contained in:
ms2k 2026-07-10 22:20:09 +09:00
commit a905f6471c

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# nordvpn-ui
Desktop GUI for the NordVPN Linux CLI. Connect by picking a country from a flag list/grid or by clicking the world map. Status is polled in the background.
Requires a working `nordvpn` CLI (logged in). Config (`config.toml`) is stored next to the binary.
```bash
cargo run --release
```
| | |
| --- | --- |
| Connect | Click map or country list |
| Switch without confirm | Double-click |
| Disconnect | Bottom-left button |
| Favorites / CLI path / poll rate | **Configure** |
Design notes: [`SPEC.md`](SPEC.md).