From ae5865a2dcb82157798de69bfabd5dc8619b59f8 Mon Sep 17 00:00:00 2001
From: Gabriel Tofvesson <gabto095@student.liu.se>
Date: Sat, 7 Nov 2020 02:01:47 +0100
Subject: [PATCH] Create README.md

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

diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..d00cd18
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,65 @@
+# NetObserve
+
+The focus of this project is to enable easy extensibility of packet structures
+
+## Packet types
+
+### Link
+
+* MAC (`dev.w1zzrd.packets.link.EthernetPacket`)
+
+* ARP (*Planned*)
+
+* NDP (*Planned*)
+
+* OSPF (*Planned*)
+
+* L2TP (*Planned*)
+
+* PPP (*Planned*)
+
+* RARP (*Planned*)
+
+### Network
+
+* IPv4 (`dev.w1zzrd.packets.network.IP4Packet`)
+
+* IPv6 (*Planned*)
+
+* ICMP (*Planned*)
+
+* ICMPv6 (*Planned*)
+
+* ECN (*Planned*)
+
+* IGMP (*Planned*)
+
+* IPsec (*Planned*)
+
+### Transport
+
+* TCP (*Planned*)
+
+* UDP (*Planned*)
+
+* DCCP (*Planned*)
+
+* RSVP (*Planned*)
+
+* QUIC (*Planned*)
+
+### Application
+
+* DNS (*Planned*)
+
+* HTTP (*Planned*)
+
+* HTTPS (*Planned*)
+
+* Telnet (*Planned*)
+
+* NTP (*Planned*)
+
+* SSH (*Planned*)
+
+* TLS/SSL (*Planned*)
\ No newline at end of file