From 700e77a3edba7d3ae2b3adeedc61c0003c6d2e1c Mon Sep 17 00:00:00 2001 From: Marcel Date: Sun, 4 Jan 2015 12:21:42 +0100 Subject: [PATCH] Wrote readme. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index e69de29..dd13242 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,18 @@ +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! + +How to add a new protocol +---- + +Clone. Check structure-schema.yml. Install kwalify (has ruby as dependency!). Write protocol file in ./protocols/osi< layer >/< protocolname >.yml. Validate structure with 'kwalify -lf structure-schema.yml < path/to/protocolname >.yml. Be happy. + +How to use this dictionary +---- + +Clone. Get a YAML library for your program language. Load desired protocol files, or all of them. Use resulting data structures to build protocol packet structures. + +This repository will provide examples or useable code snippets for specific programming languages in the future... \ No newline at end of file