projects/Store_emails_in_csv/README.md: update with project description

Merged in upstream changes into my work in progress

Author: tripleee

projects/Store_emails_in_csv/README.md

@@ -1,31 +1,54 @@
-# Store mails in your inbox in csv format
-<!--Remove the below lines and add yours -->
-1)This script takes your email and password as input.
-
-2)Return a csv containing following attributes:
-
--Date
-
--From(Sender)
-
--Subject
-
--Mail Text
-
-
-## Prerequisites
-<!--Remove the below lines and add yours -->
-You only need Python to run this script. You can visit [here](https://www.python.org/downloads/) to download Python.
-
-
-## How to run the script
-<!--Remove the below lines and add yours -->
-Running the script is really simple! Just open a terminal in the folder where your script is located and run the following command :
-
- `pip install -r requirements.txt`
- `python store_emails.py`
-
-
-## *Author Name*
-<!--Remove the below lines and add yours -->
-gpriya32(Priyanka)
+# Store emails in CSV
+
+This project contains a simple script to extract email messages
+from an IMAP server.
+
+The messages are written to a simple four-column CSV file.
+
+
+## Dependencies
+
+This depends on the BeautifulSoup library
+for extracting text from HTML messages.
+
+
+## Running the script
+
+You will need to have a file `credentials.txt`
+with your IMAP server account name and password on separate lines.
+
+This generates `mails.csv` in the current directory.
+
+```
+python store_emails.py
+```
+
+The generate CSV file contains the following fields for each message:
+
+* Date
+* From (Sender)
+* Subject
+* Message text
+
+
+## Development ideas
+
+This hardcodes the IMAP server for Gmail.com and the `"INBOX"` folder.
+Perhaps this should be configured outside of the code
+for easier customization.
+
+This brutally marks all messages as read.
+Perhaps make it `PEEK` so as to not change the message flags.
+
+This will read everything in the `INBOX` folder.
+It could be useful to make it remember which messages it has already seen,
+and update a CSV file only with information from messages which have
+arrived since the previous poll.
+
+It might be useful to be able to specify which messages to fetch,
+instead of have it fetch everything every time.
+
+
+## Author Name
+
+Aditya Jetely (@AdityaJ7)