From 4c142b2e11de5d4aba073804402955828d85923b Mon Sep 17 00:00:00 2001 From: bill Date: Sat, 26 Sep 2026 22:32:04 +0000 Subject: [PATCH] Add project description and goals to README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 222a5e0..be15649 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # vpn-dns-gateway -SSW 590 Group 1 startup product repository. \ No newline at end of file +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`. \ No newline at end of file -- 2.54.0