initial commit

README.md

@@ -0,0 +1,53 @@
+# Dark Shield
+
+A simple, lightweight GUI for managing WireGuard VPN connections on Linux.
+
+<img src="./imgs/screenshot.png" width="175" height="325" />
+
+## Features
+
+- Load WireGuard `.conf` files
+- Connect/disconnect with one click
+- Real-time connection status monitoring
+- Clean, minimal dark mode interface
+
+## Requirements
+
+- Linux (Debian-based distributions)
+- WireGuard Tools (`wireguard-tools`)
+
+## Installation
+
+Download the `.deb` package from releases and install:
+
+```bash
+sudo dpkg -i dark-shield_*.deb
+```
+
+The package automatically configures passwordless WireGuard operations for users in the `sudo` group.
+
+## Usage
+
+1. Launch Dark Shield
+2. Click "Load Config" and select your `.conf` file
+3. Click "Connect" to establish the VPN connection
+4. Click "Disconnect" when done
+
+The app stores your last loaded config and will remember it between sessions.
+
+## Development
+
+```bash
+# Install dependencies
+yarn install
+
+# Run in development mode
+yarn dev
+
+# Build .deb package
+yarn build:deb
+```
+
+## License
+
+ISC License - see LICENSE file for details.