Merge branch 'master' into patch-1

1 files changed, 21 insertions, 6 deletions

diff --git a/README.md b/README.md
index 4b5d99d..003ff58 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ Get this great stuff without effort:
     * view and write emails while you're away from
       the internet
     * make backups
+- Provides a `mailsync` script that can be scheduled to run as often as you
+  like, which downloads/syncs mail and notifies you when new mail has arrived.
 
 Specifically, this wizard:
 
@@ -27,9 +29,10 @@ Specifically, this wizard:
 #### Dependencies
 
 - `neomutt` - the email client.
-- `isync` - downloads and syncs the mail. (required at install)
+- `curl` - tests connections (required at install).
+- `isync` - downloads and syncs the mail (required if storing IMAP mail locally).
 - `msmtp` - sends the email.
-- `pass` - safely encrypts passwords (required at install)
+- `pass` - safely encrypts passwords (required at install).
 
 **Note**: There's a chance of errors if you use a slow-release distro like Ubuntu, Debian,
 or Mint. If you get errors in `neomutt`, install the most recent version
@@ -45,6 +48,16 @@ sudo make install
 A user of Arch-based distros can also install mutt-wizard from the AUR as
 [mutt-wizard-git](https://aur.archlinux.org/packages/mutt-wizard-git/).
 
+### Optional Dependencies
+
+- `pam-gnupg` - Automatically logs you into your GPG key on login so you will never need to input your password once logged on to your system. Check the repo and directions out [here](https://github.com/cruegge/pam-gnupg).
+- `lynx` - view HTML email in neomutt.
+- `notmuch` - index and search mail. Install it and run `notmuch setup`, tell it that your mail is in `~/.local/share/mail/` (although `mw` will do this automatically if you haven't set notmuch up before). You can run it in mutt with `ctrl-f`. Run `notmuch new` to process new mail.
+- `abook` - a terminal-based address book. Pressing tab while typing an address to send mail to will suggest contacts that are in your abook.
+- `urlview` - outputs urls in mail to browser.
+- `cronie` - (or any other major cronjob manager) to set up automatic mail syncing.
+
+
 ## Usage
 
 The mutt-wizard runs via the command `mw`. Once setup is complete, you'll use
@@ -56,6 +69,8 @@ The mutt-wizard runs via the command `mw`. Once setup is complete, you'll use
 - `mw -Y` -- sync all configured email accounts
 - `mw -d` -- choose an account to delete
 - `mw -D your@email.com` -- delete account settings without confirmation
+- `mw -t 30` -- toggle automatic mailsync to every 30 minutes
+- `mw -T` -- toggle mailsync without specifying minutes (default is 10)
 - `pass edit mw-your@email.com` -- revise an account's password
 
 ### Options usable when adding an account
@@ -64,7 +79,7 @@ The mutt-wizard runs via the command `mw`. Once setup is complete, you'll use
 
 - `-u` -- Give an account username if different from the email address.
 - `-n` -- A real name to be used by the account. Put in quotations if multiple
-  words
+  words.
 - `-i` -- IMAP server address
 - `-I` -- IMAP server port (otherwise assumed to be 993)
 - `-s` -- SMTP server address
@@ -126,8 +141,7 @@ To give you an example of the interface, here's an idea:
   steps to install the system.
 - `mw` is now an installed program instead of just a script needed to be kept in
   your mutt folder.
-- `dialog` is no longer used (i.e. bloat) and the interface is simply text
-  commands.
+- `dialog` is no longer used and the interface is simply text commands.
 - More autogenerated shortcuts that allow quickly moving and copying mail
   between boxes.
 - More elegant attachment handling. Image/video/pdf attachments without relying
@@ -140,11 +154,12 @@ To give you an example of the interface, here's an idea:
 - `pass` is used as a password manager instead of separately saving passwords.
 - Script is POSIX sh compliant.
 - Error handling for the many people who don't read or follow directions. Fewer
-  errors, generally.
+  errors generally.
 - Addition of a manual `man mw`
 
 ## Help the Project!
 
+
 - Try mutt-wizard out on weird machines and weird email addresses and report any
   errors.
 - Open a PR to add new server information into `domains.csv` so their users can