From a26d0a1aba243c6b3142b1fe9a3c74d84daccacb Mon Sep 17 00:00:00 2001 From: Marcel Date: Sun, 4 Jan 2015 16:30:26 +0100 Subject: [PATCH] readme clarification --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ab3b87..41e1a81 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,16 @@ Network Protocol Dictionary This is a YAML network protocol dictionary for all (binary based) OSI-Layer 1-4 protocols, eg. Ethernet, IP, TCP, UDP, etc. -The list may not be complete, if you're missing a protocol, just add it! +- What this dictionary should be: + - A complete **machine readable** *structure definition* for all binary based network protocols + - Addon: some protocol documentation from wikipedia or RFCs for display use. + - A reference for building a network packet from scratch in an application, mostly for applications dealing with network packets. + +- What it is clearly **NOT**: + - Currently: complete. + - A replacement for reading RFCs + - A source for implementing network stacks + How to add a new protocol ----