From 7e929f3a32ad41c44f8d324080693a7eaeb4f885 Mon Sep 17 00:00:00 2001
From: Pierre-Olivier Mercier <nemunaire@nemunai.re>
Date: Wed, 12 Oct 2016 00:31:50 +0200
Subject: [PATCH] Initial commit

---
 .gitignore |  5 +++++
 README.md  | 24 ++++++++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d1ab267
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+*#
+*~
+TAGS
+*.py[cod]
+__pycache__
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c44f760
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Peret
+=====
+
+Peret checks PGP signed mails and extract submissions contained in it.
+
+
+Usage
+-----
+
+A basic usage is through procmail; append thoses lines into your
+`~/.procmailrc`:
+
+```
+:0H
+* ^Delivered-To: peret@domain\.tld
+{
+    :0c
+    * !^X-loop:
+    | /path/to/peret/check.py --real-send --submissions /path/to/shemu/submissions/TP3 --soft-max-submission "october 20 08:42" --hard-max-submission "october 20 09:21"
+
+    :0
+    $DEFAULT
+}
+```