From 9c7653c461f523228096bbe4c014abcb1e02d96e Mon Sep 17 00:00:00 2001
From: Ahmed AbdelHalim <pm@a14m.me>
Date: Wed, 10 Sep 2025 15:53:41 +0200
Subject: Update README

---
 README.md | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 0770e1f..276bb71 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,38 @@
-# WireGuard Gateway Portal
+# WireGuard Gateway Portal (wg-portal)
 
 A lightweight web interface for managing WireGuard VPN connections.
 
 Ideal for managing the VPN connection running on a RaspberryPi Network Gateway.
 
-## Quick Start
+## Installation
 
-1. **Configure WireGuard connections** in `/etc/wireguard/*.conf`
-1. **Update configuration** in `config.yaml` (optional)
-1. **Run the application**: `go run main.go`
-1. **Open your browser** to `http://localhost:8080`
+```bash
+curl -fsSL https://git.sr.ht/~a14m/wg-portal/blob/main/deployment/install.sh | sudo bash
+```
 
 ## Development
 
+Dependencies:
+
 - **Go 1.25+** - For running the application
 - **Node.js/npx** - (optional) For frontend linting (HTML/CSS/JS)
 - **golangci-lint** - (optional) Go linting
 
-### Linting
+Steps:
+
+1. Clone the repo
+1. Configure WireGuard connections in `/etc/wireguard/*.conf`
+1. Update configuration in `<repo>/config.yaml` (optional)
+1. Run the application: `go run main.go`
+1. Open your browser to `http://localhost:8080`
+
+## Uninstall
+
+```bash
+curl -fsSL https://git.sr.ht/~a14m/wg-portal/blob/main/deployment/uninstall.sh | sudo bash
+```
+
+## Linting
 
 ```bash
 # Individual linters
@@ -25,6 +40,7 @@ make lint-js    # JavaScript (ESLint)
 make lint-css   # CSS (Stylelint)
 make lint-html  # HTML (html-validate)
 make lint-go    # Go (go vet + golangci-lint)
+make lint-shell # Shell scripts (shellcheck)
 
 # All linters
 make lint
@@ -32,3 +48,10 @@ make lint
 # Help
 make help
 ```
+
+## Release
+
+```bash
+git tag -a v[major].[minor].[patch]
+git push --tags
+```
-- 
cgit v1.2.3