initial commit

1 files changed, 38 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b10f3e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# mutt Offline email setup
+
+Mutt is one of the most rewarding programs one can use, but can be a pain in the ass to configure. Since my job is making power-user tools available for the masses I want to create a tool that automates most of mutt configuration so that users can simply give their email address and get a /comfy/ setup. At that, I don't just want a mutt wizard, but an offlineIMAP wizard, so users can easily access their mail offline as well, and a wizard that makes it easy to store passwords securely using gpg.
+
+## Progress
+
+The main scripts `mutt_install.sh` can create or add an account from a domain in `domain.csv` to `~/.offlineimaprc` without a problem.
+
+## YOU CAN HELP
+
+If you use mutt with a particular host or domain, put your server information in `domains.csv`! This will make everyone else who uses your email provider's life much easier!
+
+Or you can help monetarily via [Patreon](https://patreon.com/lukesmith) or [Paypal](https://paypal.me/LukeMSmith)!
+
+## Todo
+
+* Expand the list of server information in `domains.csv`, including adding spoolfiles/records/postponed folders for each account.
+* Write scripts that do the following:
+	* Stat `~/.offlineimaprc` and the the mutt configs to see what accounts are currently available. (**Done**, currently in `stat.sh`; needs integration.)
+	* Delete a profile from above if requested. (**Done**, currently in `removeaccount.sh`; needs integration.)
+	* Add a profile above if requested, including:
+		* An automatic search of `domains.csv` for server information. (**Done**)
+		* An ncurses menu for inputing server settings if not available in `domains.csv`. (Soon, see `manual.sh`)
+		* Differential actions for Gmail accounts since these are distinct in offlineIMAP. (**Done**)
+	* Configure notmuch with all accounts.
+	* A prompt for adding encypted passwords for each account available.
+		* Or directions for adding plain text passwords if desired.
+
+### Todo: Add settings for email accounts not unified by one domain
+
+--------
+
+zoho,imap.zoho.com,993.00,smtp.zoho.com,465.00
+icloud,imap.mail.me.com,993.00,smtp.mail.me.com,587.00
+inbox.com,imap.inbox.com,993.00,smtp.inbox.com,465.00
+office365,outlook.office365.com,993.00,smtp.office365.com,587.00
+hostgator,gator4171.hostgator.com,993.00,gator4171.hostgator.com,587.00
+godaddy,imap.secureserver.net,993,smtpout.secureserver.net,465