From b7648016bce9fbcc9bc8dae1a2888d469d2c5085 Mon Sep 17 00:00:00 2001
From: Storm Dragon <stormdragon2976@gmail.com>
Date: Sat, 4 May 2019 14:31:52 -0400
Subject: [PATCH] updated readme.

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 43 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 73ae184..f1c83a3 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,46 @@
-# fleacollar
+# Fleacollar
 
-A complete configuration utility for Mutt.
+Fleacollar is a complete configuration utility for Mutt. It is written in bash and requires at least bash version 4.2 or greater. It uses dialog to present the user interface.
 
-## Usage
+## Features
+
+The script creates or completes if need be a configuration for mutt in ~/.mutt, writing in it these files and directories if they do not exist:
+
+_ aliases
+_ mailcap
+_ gpg.rc
+_ macros
+_ muttrc
+
+During setup you will be asked to select your preferences from installed applications:
+
+_ the browser to use for viewing html email,
+_ the editor to use for text composition,
+_ the associated MIME settings case occurring,
+_ a gpg key, generated if need be or selected by the user,
+_ email addresses and the associated configurations for gmail, hotmail or generic, including the imap and/or smtp settings,
+_ contacts to include in the address book,
+
+The main dialog box presents following choices:
+
+_ Add Email Address
+_ Configure GPG
+_ New Contact
+_ Exit
+
+The user can use the OK and Cancel buttons of the dialog boxes and also exit at any time pressing Ctrl+c
+
+## Dependancies
+
+When the script is started, it checks the presence of the needed dependencies: dialog, gettext, gpg and mutt.
+
+## Authors
+
+Storm Dragon: https://social.stormdragon.tk/storm
+Michael Taboada: https://2mb.social/mwtab
+Contributor: Kyle: https://kyle.tk
+
+## Support
+
+Support is available on irc.linux-a11y.org #a11y or file an issue on [GitLab](https://gitlab.com/stormdragon2976/fleacollar)
 
-Run fleacollar and follow the prompts. If you find any bugs please open an issue on the gitlab page.