add a readme file

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..ae56948
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# MOREP: Messaging over Raw Ethernet Packets
+
+## Minimalist Ethernet connection protocol
+
+This message passing library offers unreliable connection oriented data blocks exchange messaging between software modules over raw Ethernet packets.
+
+It allows to:
+- open connections dedicated to an Ethertype on both sides
+- send and recevie fragmented payload with a minimalist overhead of 4 bytes
+- close connections
+
+## Connection emmulator
+
+With a simple set of macros and functions, the library eases the implementation of a connection emmulator. 
+
+### Usage
+
+```bash
+./morep_simulator.exe \
+    -l script-cross_crypto.log -V 3 \
+    -s CROSS_CRYPTO -t lo://00:00:00:00:00:00/0808 -r lo://00:00:00:00:00:00/0808 \
+    script-cross_crypto.eth 
+```
+
+### Script
+
+``` 
+# Cross crypto test script
+
+T:CROSS_CRYPTO ENCRYPT_CROSS_ASYNC CHANNELID=2 BYPASSLEN=4 BYPASS=11:22:33:44 DATA=@script-local_crypto.eth
+R:CROSS_CRYPTO ENCRYPT_CROSS_ASYNC CHANNELID=2 BYPASSLEN=4 BYPASS=11:22:33:44
+
+SLEEP 1000
+
+T:CROSS_CRYPTO ENCRYPTED_CROSS_ASYNC CHANNELID=9 BYPASSLEN=1 BYPASS=55 DATA=@script-local_crypto.eth
+R:CROSS_CRYPTO ENCRYPTED_CROSS_ASYNC BYPASSLEN=1 BYPASS=55
+
+T:CROSS_CRYPTO DECRYPT_CROSS_ASYNC CHANNELID=5 BYPASSLEN=0 DATA=@script-local_crypto.eth
+R:CROSS_CRYPTO DECRYPT_CROSS_ASYNC DATA=@script-local_crypto.eth
+
+T:CROSS_CRYPTO DECRYPTED_CROSS_ASYNC CHANNELID=0 BYPASSLEN=4 BYPASS=11:22:33:44 DATA=@script-cross_crypto.eth
+R:CROSS_CRYPTO DECRYPTED_CROSS_ASYNC
+```