From a812c74b74a0931fc4832aeeaf9a29c182ced718 Mon Sep 17 00:00:00 2001
From: Beau Kujath <beau@breakpointingbad.com>
Date: Fri, 1 Dec 2023 13:58:17 -0700
Subject: [PATCH] added readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c5062c6..4114178 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
 # NetworkGenie
 
-Making magic with the network stack
\ No newline at end of file
+
+### Setup
+
+1. Open and build the NetworkGenie app in AndroidStudio.
+2. Set the debug server IP in the variable at the top of `app/src/main/jni/netguard/debug_conn.c`
+3. Open a the debug port (50508) on the debug server: `nc -k -l 50508`.
+4. Start the debug server script to log outgoing app packets and test sending bakc packets to leave the Android device: `python3 sniffer.py`.
+5. Run the NetworkGenie app.
+
+
+### Testing
+
+
+
+1. NetworkGenie is hardcoded (for testing purposes) to establish the connection to the debug server after handling 10 outgoing packets and begin forwarding all outgoing traffic to the server.
+2. Scapy packets should be logged to the debug servers terminal from the python script that is printing the packet info received from the Android.
+3. Input "2" or "3" to test crafting packets that will be sent through the debug connection to NetworkGenie and forwarded out the device.
+4. Use packet capture to view packets crafted from debug server on the Android: `adb shell` -> `su` -> `tcpdump -i any host 9.9.9.9`.
+
+
+
+