From 7b06d6c6fc4d53ed69b2a722b08ce3e6e2723696 Mon Sep 17 00:00:00 2001
From: Kevin Jerebica <jerebicakevin@gmail.com>
Date: Tue, 3 Sep 2024 00:12:22 +0200
Subject: [PATCH] repo: update docs

---
 README | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/README b/README
index b6e1d1a..c316e63 100644
--- a/README
+++ b/README
@@ -2,5 +2,25 @@
 |   tinyparser   |
 +================+
 
-HTTP parsing prototype and algorithm development environment for tinyproxy - my
-new proxy.
+    HTTP parsing prototype and algorithm development 
+    environment for tinyproxy - my new proxy.
+
+    RES: github.com/tinyproxy/tinyproxy
+    RES: github.com/nginx/nginx
+
+LEAKS 
+
+    LEAKS file contains the most recent valgrind memory leaks 
+    dump ran on main.c 
+
+    LEAKS.TEST.[id] files respectively contain the most recent 
+    valgrind memory leaks dump ran on a test with an id=[id]
+
+TODO 
+    
+    * headers table needs length fields 
+    * refactor header parsing 
+    * refactor state machine 
+    * implement tests 
+    * integrations with tinyproxy..?
+