From c012842b584e37b26384a70734304b571f3aab09 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?L=C3=A1szl=C3=B3=20K=C3=A1rolyi?= <laszlo@karolyi.hu>
Date: Tue, 16 Nov 2021 14:12:39 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fb332c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# DMARC Reports analyzer using IMAP connection
+
+## Installation:
+
+- Create a virtualenv
+- Install packages from requirements.txt (`python -m pip install -r requirements.txt`)
+- Create a configuration: `python analyze.py -c <CONFIG_PATH> --recreate`
+- Adjust the initial values in your `<CONFIG_PATH>`
+- Initialize the sqlite3 db: `python analyze.py -c <CONFIG_PATH> --init-db`
+
+## Usage:
+
+After you've set up the configuration, run the utility with only the config file parameter `-c <CONFIG_PATH>` to collect the results into the sqlite db.
+If you want to load the collected reports and send them in a summarized email, use the `--report` option.
+
+## Command line help
+
+`python analyze.py -h`