From 725737f8c3556d0de6cb56edaaead9d1170e6b04 Mon Sep 17 00:00:00 2001
From: Christian Risi <75698846+CnF-Gris@users.noreply.github.com>
Date: Thu, 5 Jun 2025 11:21:34 +0200
Subject: [PATCH] V0.1.1 Added a bit of documentation

---
 README.MD | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..f44615e
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,22 @@
+# Suricata-Logger
+
+This sofware is aimed to everyone that  would like
+to have interactive feedback from Suricata, like
+in CTF competitions, or Threat Analyses run
+independently.
+
+## How to use it
+
+You need to start the software with `deno run` and
+then run `suricata -i insert_tap_device_here`.
+
+> [!NOTE]
+> This is ***not*** a comprehensive list on ***how to
+> run Suricata***. As long as you have Suricata output
+> its `eve` file like a `unix_stream` and modify the
+> socket accordingly, everything should work.
+
+> [!CAUTION]
+> Since you are streaming data, be sure to ***exclude
+> this traffic*** from being logged, otherwise you'll
+> have a ***feedback loop***