Main function refactored and connection failure exception handling added
[imap-fix-internaldate] / README
diff --git a/README b/README
index 5dd4f23..347da3b 100644 (file)
--- a/README
+++ b/README
@@ -20,10 +20,18 @@ An alternative approach would be to interpret the "Date:" header.
 Prerequisites:
 Python version 3 or later
 
+Necessary files:
+- userdata.csv: Contains information necessary for the user session with format:
+               username,password
+               testuser1,testpass1
+               testuser2,testpass2
 
-*** TO DOCUMENT ***
-- How to invoke
-necessary files
-- Invocation on Windows
+Produced files:
+- confscript.cfg: Configuration of the script - created on first run.
+- message_cache.dat: Cache file used for performance improvements
+- fix_imap_internaldate.log: Log file that resets with the script.
+- conflict_stats.txt: Final report on statistics about detected date conflicts and missing dates.
+
+Invocation on Windows requires and results in the same files.
 
 For more information please contact opensource@intra2net.com