From 02aac657fabc471b3b837b7992c527805a441688 Mon Sep 17 00:00:00 2001
From: vanheesmaxime <102608520+vanheesmaxime@users.noreply.github.com>
Date: Thu, 1 Jun 2023 15:58:04 +0200
Subject: [PATCH 1/2] Create README.md

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..966ae66
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+# masterproef_v2
+
+To run:
+- make sure there is no route for 200::/7 yet (can be the case on fresh TFT Grid VMs)
+- cargo run (-p for optional peers)
+- 

From c0fc2af6bd3596ae4f5c3ed3e921a38be7a384fe Mon Sep 17 00:00:00 2001
From: vanheesmaxime <102608520+vanheesmaxime@users.noreply.github.com>
Date: Tue, 6 Jun 2023 11:45:26 +0200
Subject: [PATCH 2/2] Update README.md

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++----
 1 file changed, 39 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 966ae66..e198e76 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,41 @@
 # masterproef_v2
 
-To run:
-- make sure there is no route for 200::/7 yet (can be the case on fresh TFT Grid VMs)
-- cargo run (-p for optional peers)
-- 
+This POC aims to create an IPv6 overlay network compeletly writting in Rust. The overlay network uses some of the core principles of the Babel routing protocol (https://www.irif.fr/~jch/software/babel/). Each node that joins the overlay network will receive an overlay network IP in the 200::/7 range. 
+
+## Installation
+
+```sh
+git clone git@github.com:vanheesmaxime/masterproef_v2.git
+# in case of an exisiting route to 200::/7, it should be deleted in order to run the application
+ip r del 200::/7
+```
+
+## Usage example
+In this example setup we create a small overlay network on 5 different virtual machines that looks like this:
+
+
+```
++----------+        +----------+        +--------+
+| node 1   |--------| node 2   |--------| node 3 |
++----------+        +----------+        +--------+
+     |                                   |
+     |   +--------+        +-------+     |
+     +---| node 4 |--------| node 5|-----+
+         +--------+        +-------+
+```
+To create this setup, run the following commands:
+
+```sh
+# node 1
+cargo run
+# node 2
+cargo run -- -p <IP address node 1>
+# node 3
+cargo run -- -p <IP address node 2>
+# node 4
+cargo run -- -p <IP address node 1>
+# node 5
+cargo run -- -p <IP address node 4> -p <IP address node 3>
+```
+
+