Merge pull request 'Add project description and goals to README' (#8) from 1-readme-description into main

Reviewed-on: #8 Reviewed-by: vsun1 <vsun4046@gmail.com>
2026-09-27 01:34:08 +00:00
parent b1f4f85146 4c142b2e11
commit 6f310c7085
1 changed files with 15 additions and 1 deletions
@@ -1,3 +1,17 @@
 # vpn-dns-gateway
 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`.