Add project description and goals to README

2026-09-26 22:32:04 +00:00
1 changed files with 15 additions and 1 deletions
@@ -1,3 +1,17 @@
 # vpn-dns-gateway

-SSW 590 Group 1 startup product repository.
+SSW 590 Group 1 startup product repository.
+
+## Project
+**Resource-Constrained Personal VPN and DNS Gateway**: a self-hosted VPN
+and DNS ad-blocking gateway for our own laptops and phones, running on a
+1 vCPU / 512 MB DigitalOcean droplet.
+
+## Goals
+- Run a VPN and optional DNS filtering reliably within 512 MB of RAM.
+- Measure memory, disk, and stability under bounded load.
+- Show gateway health on a simple operations dashboard.
+
+## Team workflow
+Every change goes through an issue-linked branch, a pull request, and one
+approving peer review before merging to `main`.