From d2780f5780609d2b401928c830e2869489a4d05c Mon Sep 17 00:00:00 2001
From: Jeffrey Bencteux <jeffbencteux@gmail.com>
Date: Thu, 6 Oct 2022 14:55:36 +0200
Subject: [PATCH] update readme

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 931b915..b9e25ff 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
 # mailsecchk
-POSIX script for mail security checks of domain names
+
+A simple POSIX script for mail security checks against domain names.
+
+```
+Usage: ./mailsecchk.sh [OPTIONS]...
+check mail security of a given domain
+
+arguments:
+  -d domain to be checked
+  -h display this help and exit
+  -l log file to output to
+```
+
+## Current checks
+
+* SPF DNS record presence
+* SPF not using FAIL mode "-all"
+* DMARC DNS record presence
+* DMARC policy ("p")
+* DMARC subpolicy ("sp")
+* DMARC sample percentage ("pct")
+* DMARC aggregation and forensic reports send to third-parties ("rua" and "ruf")
+* DKIM dictionnary guess for selectors (list is in dkim_selectors.txt)
+
+Specific to Microsoft 365:
+
+* SPF set to include M365 SPF
+* DKIM presence (selectors are predictable)
+
+## Examples
+
+![example 1](img/altf8.png "Example 1")
+
+![example 2](img/lemonde.png "Example 2")