From 44d7bda6ed2a44fbb1b83586e56f24cb198c937c Mon Sep 17 00:00:00 2001
From: Zachary Seguin <ztseguin@csclub.uwaterloo.ca>
Date: Sat, 21 Nov 2015 13:21:42 -0500
Subject: [PATCH] Update documentation

---
 README | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README b/README
index aa3cb45..60ad95e 100644
--- a/README
+++ b/README
@@ -9,4 +9,28 @@ GENERATE
 --------
 
 $ . .venv/bin/activate
-$ ./generate_hosts.py < hosts.in
+$ ./generate_hosts.py < hosts.in > hosts
+
+
+FORMAT OF HOSTS
+---------------
+
+There are 4 types of lines:
+
+- Whitespace
+- Lines starting with # are a comment
+- Lines starting with a ! are copied word-for-word (minues the bang)
+- Other lines are resolved through DNS
+
+EXAMPLE
+-------
+
+* hosts.in
+
+# HOSTS
+!127.0.0.1 localhost
+hostname.csclub.uwaterloo.ca
+
+* hosts
+127.0.0.1 localhost
+129.97.134.111 hostname.csclub.uwaterloo.ca hostname