more readable and useful README

README

@@ -1,13 +0,0 @@
-Crawl through sent email folder and make plots of
-- day vs time of day when emails were sent
-
-Future additions:
-
-  * histograms collapsed along different axes
-- histogram of popular email addresses
-- gant chart of when email addresses were being emailed
-- histogram of number of attachments and size of attachments
-- histogram of number of recipients
-- word count of emails?
-- python natural language toolkit analysis?
-

README.md

@@ -0,0 +1,46 @@
+# Email Analytics
+
+A short script to do simple analysis of mbox email files.
+
+Currently the script:
+
+* plots time vs day of all emails, optionally color-coded by user-specified sender information
+
+In the future, I would like to add capabilities to:
+
+* histograms collapsed along different axes
+* histogram of popular email addresses
+* gant chart of when email addresses were being emailed
+* histogram of number of attachments and size of attachments
+* histogram of number of recipients
+* word count of emails?
+* python natural language toolkit analysis?
+
+## Usage
+
+For usage information:
+
+```
+$ python email_stats.py -h
+usage: email_stats.py [-h] [--plotfile PLOTFILE] [--title TITLE]
+                      [--sendercolors SENDERCOLORS]
+                      mbox
+
+positional arguments:
+  mbox                  Mailbox to analyze.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --plotfile PLOTFILE, -p PLOTFILE
+                        Name of output plotting file.
+  --title TITLE, -t TITLE
+                        Plot title.
+  --sendercolors SENDERCOLORS, -s SENDERCOLORS
+                        Comma separated list of search strings for the sender
+                        field. Each will be displayed with a different color.
+```
+
+
+## License
+
+The script is licensed under the GPLv3.