From 6f539352df532681945e0afea4954d1e7311fb8a Mon Sep 17 00:00:00 2001
From: gurkenhabicht <34342412+gurkenhabicht@users.noreply.github.com>
Date: Wed, 13 May 2020 10:55:56 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..78c4a01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# This is experimental
+
+This version is a successor of the _POSIX_C_SOURCE 200809L implementation in which all of the data of a parsed pcap/pcapng file is written as a single and simple query. This is rather fast (tested writes: 100*10^3 tcp packets in ~1.8 sec) but may be insecure. 
+  
+Postgres databases have a custom maximum limit on each insert query of prepared statements. In order to solve this issue, parsed data is written in chunks. This value is initialized in the config file called parser.json as `insert_max`.
+
+Currently, ethernet, IPv4 and TCP are the only network protocols handled.