misc: Add a readme to describe the project purpose a bit

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c36da97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+osmo-pcap consists out of the osmo-pcap-client to cpature traffic at a
+host and osmo-pcap-server to receive the traffic, store and rotate the
+traffic at a centralized server. There is a shell script to compress
+and expire old traces.
+
+The osmo-pcap-client is using libpcap and has a built-in detector for
+the GPRS-NS/BSSGP protocol to exclude user traffic. The client is known
+to work on 32/64 bit systems. It can be configured through the VTY and
+the minimal config includes the interface to monitor, the pcap filter
+to use and the server to send it to.
+
+
+The osmo-pcap-server will listen for new TCP connections and then will
+receive the data from the client if it is coming from a known/good source
+IPv4/port. The server is configured to write one file per client and to
+change/rotate the file when the link encapsulation is changing. It can
+be configured to rotate the file a given time interval and/or if the
+filesize is over a threshold.
+
+The osmo-pcap-server comes with a shell script to rotate and compress
+old traces. Currently the configuration parameters (age or amount based)
+need to be tuned in the script itself.