Add licencing, README and file hierarchy
[imap-mark-seen] / README
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..6a8fdda
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+Small tool to mark all e-mails as seen.
+
+Features:
+- Usage of massive server-side flag set operations
+
+Prerequisites:
+Python version 3 or later
+
+    Linux: Should be part of any modern linux distribution
+    Windows: Get it from http://www.python.org/getit/windows/
+
+Files that can be used by the program:
+- none
+
+Files that may be produced by the program:
+- imap_mark_seen.log: Log file. Will be truncated on script invocation.
+
+
+For more information please contact opensource@intra2net.com