README.md: Add screenshots and update text

4 files changed, 271 insertions, 0 deletions

diff --git a/docs/samples/sample-config.toml b/docs/samples/sample-config.toml
new file mode 100644
index 00000000..367310a7
--- /dev/null
+++ b/docs/samples/sample-config.toml
@@ -0,0 +1,117 @@
+## Look into meli.conf(5) for all valid configuration options, their
+## descriptions and default values
+##
+## The syntax for including other configuration files is enclosed in `:
+##`include("account_one")`
+##`include("./account_two")`
+##`include("/home/absolute/path/to/shortcuts/config.toml")`
+##
+##
+## Setting up a Maildir account
+#[accounts.account-name]
+#root_mailbox = "/path/to/root/mailbox"
+#format = "Maildir"
+#index_style = "Conversations" # or [plain, threaded, compact]
+#identity="email@address.tld"
+#display_name = "Name"
+#subscribed_mailboxes = ["INBOX", "INBOX/Sent", "INBOX/Drafts", "INBOX/Junk"]
+#
+## Set mailbox-specific settings
+#  [accounts.account-name.mailboxes]
+#  "INBOX" = { rename="Inbox" }
+#  "drafts" = { rename="Drafts" }
+#  "foobar-devel" = { ignore = true } # don't show notifications for this mailbox
+#
+## Setting up an mbox account
+#[accounts.mbox]
+#root_mailbox = "/var/mail/username"
+#format = "mbox"
+#index_style = "Compact"
+#identity="username@hostname.local"
+#
+## Setting up an IMAP account
+#[accounts."imap"]
+#root_mailbox = "INBOX"
+#format = "imap"
+#server_hostname="mail.server.tld"
+#server_password="pha2hiLohs2eeeish2phaii1We3ood4chakaiv0hien2ahie3m"
+#server_username="username@server.tld"
+#server_port="993" # imaps
+#server_port="143" # STARTTLS
+#use_starttls=true #optional
+#index_style = "Conversations"
+#identity = "username@server.tld"
+#display_name = "Name Name"
+### match every mailbox:
+#subscribed_mailboxes = ["*" ]
+### match specific mailboxes:
+##subscribed_mailboxes = ["INBOX", "INBOX/Sent", "INBOX/Drafts", "INBOX/Junk"]
+#
+## Setting up an account for an already existing notmuch database
+#[accounts.notmuch]
+#root_mailbox = "/path/to/folder" # where .notmuch/ directory is located
+#format = "notmuch"
+#index_style = "conversations"
+#identity="username@server.tld"
+#display_name = "Name Name"
+#  # notmuch mailboxes are virtual, they are defined by their alias and the notmuch query that corresponds to their content.
+#  [accounts.notmuch.mailboxes]
+#  "INBOX" = {  query="tag:inbox", subscribe = true }
+#  "Drafts" = {  query="tag:draft", subscribe = true }
+#  "Sent" = {  query="from:username@server.tld from:username2@server.tld", subscribe = true }
+##
+#[pager]
+#filter = "COLUMNS=72 /usr/local/bin/pygmentize -l email"
+#pager_context = 0 # default, optional
+#headers_sticky = true # default, optional
+#
+#[notifications]
+#script = "notify-send"
+#xbiff_file_path = "path" # for use with xbiff(1)
+#play_sound = true # default, optional
+#sound_file = "path" # optional
+#
+###shortcuts
+#[shortcuts.composing]
+#edit_mail = 'e'
+#
+##Thread view defaults:
+#[shortcuts.compact-listing]
+#exit_thread = 'i'
+#
+#[shortcuts.contact-list]
+#create_contact = 'c'
+#edit_contact = 'e'
+#
+##Mail listing defaults
+#[shortcuts.listing]
+#prev_page = "PageUp"
+#next_page = "PageDown"
+#prev_mailbox = 'K'
+#next_mailbox = 'J'
+#prev_account = 'l'
+#next_account = 'h'
+#new_mail = 'm'
+#set_seen = 'n'
+#
+##Pager defaults
+#
+#[shortcuts.pager]
+#scroll_up = 'k'
+#scroll_down = 'j'
+#page_up = "PageUp"
+#page_down = "PageDown"
+#
+#[composing]
+##required for sending e-mail
+#send_mail = 'msmtp --read-recipients --read-envelope-from'
+##send_mail = { hostname = "smtp.mail.tld", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
+#editor_command = 'vim +/^$' # optional, by default $EDITOR is used.
+#
+#
+#[pgp]
+#auto_sign = false # always sign sent messages
+#auto_verify_signatures = true # always verify signatures when reading signed e-mails
+#
+#[terminal]
+#theme = "dark" # or "light"
diff --git a/docs/samples/themes/orca.toml b/docs/samples/themes/orca.toml
new file mode 100644
index 00000000..7f5aab42
--- /dev/null
+++ b/docs/samples/themes/orca.toml
@@ -0,0 +1,62 @@
+[terminal.themes.orca]
+color_aliases = { "neon_green" = "#6ef9d4",  "darkgrey" = "#4a4a4a",  "neon_purple" = "#df2f94"  }
+"theme_default" = { fg = "White", bg = "Black", attrs = "Default" }
+"mail.listing.attachment_flag" = { fg = "$neon_green", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.compact.even" = { fg = "$darkgrey", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.compact.even_highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"mail.listing.compact.even_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.compact.even_unseen" = { fg = "Black", bg = "Grey78", attrs = "theme_default" }
+"mail.listing.compact.odd" = { fg = "$darkgrey", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.compact.odd_highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"mail.listing.compact.odd_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.compact.odd_unseen" = { fg = "Black", bg = "Grey78", attrs = "theme_default" }
+"mail.listing.conversations" = { fg = "$darkgrey", bg = "theme_default", attrs = "Default" }
+"mail.listing.conversations.date" = { fg = "$neon_purple", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.from" = { fg = "$darkgrey", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"mail.listing.conversations.padding" = { fg = "Black", bg = "Black", attrs = "theme_default" }
+"mail.listing.conversations.selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.conversations.subject" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.unseen" = { fg = "Black", bg = "Grey78", attrs = "theme_default" }
+"mail.listing.conversations.unseen_padding" = { fg = "Black", bg = "Black", attrs = "theme_default" }
+"mail.listing.plain.even" = { fg = "theme_default", bg = "Grey19", attrs = "theme_default" }
+"mail.listing.plain.even_highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"mail.listing.plain.even_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.plain.even_unseen" = { fg = "Black", bg = "Grey78", attrs = "theme_default" }
+"mail.listing.plain.odd" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.odd_highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"mail.listing.plain.odd_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.plain.odd_unseen" = { fg = "Black", bg = "Grey78", attrs = "theme_default" }
+"mail.listing.tag_default" = { fg = "Black", bg = "$neon_green", attrs = "theme_default" }
+"mail.listing.thread_snooze_flag" = { fg = "Red", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar" = { fg = "$darkgrey", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_highlighted" = { fg = "Grey7", bg = "White", attrs = "theme_default" }
+"mail.sidebar_highlighted_account" = { fg = "$darkgrey", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_name" = { fg = "White", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_account_name" = { fg = "$darkgrey", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_index" = { fg = "mail.sidebar_index", bg = "mail.sidebar_highlighted_account", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_unread_count" = { fg = "mail.sidebar_unread_count", bg = "mail.sidebar_highlighted_account", attrs = "theme_default" }
+"mail.sidebar_highlighted_index" = { fg = "mail.sidebar_index", bg = "mail.sidebar_highlighted", attrs = "theme_default" }
+"mail.sidebar_highlighted_unread_count" = { fg = "mail.sidebar_highlighted", bg = "mail.sidebar_highlighted", attrs = "theme_default" }
+"mail.sidebar_index" = { fg = "Grey46", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_unread_count" = { fg = "Grey46", bg = "theme_default", attrs = "theme_default" }
+"mail.view.body" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.view.headers" = { fg = "DodgerBlue1", bg = "theme_default", attrs = "theme_default" }
+"mail.view.thread.indentation.a" = { fg = "theme_default", bg = "#EC4436", attrs = "theme_default" }
+"mail.view.thread.indentation.b" = { fg = "theme_default", bg = "#D301F9", attrs = "theme_default" }
+"mail.view.thread.indentation.c" = { fg = "theme_default", bg = "#314EFB", attrs = "theme_default" }
+"mail.view.thread.indentation.d" = { fg = "theme_default", bg = "#068ACD", attrs = "theme_default" }
+"mail.view.thread.indentation.e" = { fg = "theme_default", bg = "#019589", attrs = "theme_default" }
+"mail.view.thread.indentation.f" = { fg = "theme_default", bg = "#68A033", attrs = "theme_default" }
+"pager.highlight_search" = { fg = "White", bg = "Teal", attrs = "Bold" }
+"pager.highlight_search_current" = { fg = "White", bg = "NavyBlue", attrs = "Bold" }
+"status.bar" = { fg = "White", bg = "Black", attrs = "theme_default" }
+"status.notification" = { fg = "Plum1", bg = "DarkRed", attrs = "theme_default" }
+"tab.bar" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"tab.focused" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"tab.unfocused" = { fg = "$darkgrey", bg = "Black", attrs = "theme_default" }
+"widgets.form.field" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"widgets.form.highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"widgets.form.label" = { fg = "theme_default", bg = "theme_default", attrs = "Bold" }
+"widgets.list.header" = { fg = "Black", bg = "White", attrs = "Bold" }
+"widgets.options.highlighted" = { fg = "theme_default", bg = "Grey", attrs = "theme_default" }
diff --git a/docs/samples/themes/spooky.toml b/docs/samples/themes/spooky.toml
new file mode 100644
index 00000000..b04ed06a
--- /dev/null
+++ b/docs/samples/themes/spooky.toml
@@ -0,0 +1,44 @@
+[terminal.themes.spooky]
+"theme_default" = { fg = "#333", bg = "#fe9b13", attrs = "Default" }
+"mail.listing.attachment_flag" = { fg = "LightSlateGrey", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.compact.even" = { fg = "theme_default", bg = "#bf200e", attrs = "theme_default" }
+"mail.listing.compact.odd" = { fg = "theme_default", bg = "#fa4113", attrs = "theme_default" }
+"mail.listing.compact.even_highlighted" = { fg = "theme_default", bg = "Yellow6", attrs = "theme_default" }
+"mail.listing.compact.odd_highlighted" = { fg = "theme_default", bg = "Yellow6", attrs = "theme_default" }
+"mail.listing.compact.even_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.compact.odd_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.compact.even_unseen" = { fg = "Black", bg = "Orange3", attrs = "theme_default" }
+"mail.listing.compact.odd_unseen" = { fg = "Black", bg = "Orange3", attrs = "theme_default" }
+"mail.listing.conversations.date" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.from" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.highlighted" = { fg = "theme_default", bg = "Grey58", attrs = "theme_default" }
+"mail.listing.conversations.padding" = { fg = "Grey15", bg = "Grey15", attrs = "theme_default" }
+"mail.listing.conversations.selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.conversations.subject" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.unseen" = { fg = "Black", bg = "Grey78", attrs = "theme_default" }
+"mail.listing.conversations.unseen_padding" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.even" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.odd" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.even_unseen" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.odd_unseen" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.even_highlighted" = { fg = "theme_default", bg = "Yellow6", attrs = "theme_default" }
+"mail.listing.plain.odd_highlighted" = { fg = "theme_default", bg = "Yellow6", attrs = "theme_default" }
+"mail.listing.plain.even_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.plain.odd_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.thread_snooze_flag" = { fg = "Red", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_highlighted_account" = { fg = "White", bg = "Orange3", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_index" = { fg = "mail.sidebar_index", bg = "mail.sidebar_highlighted_account", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_unread_count" = { fg = "mail.sidebar_unread_count", bg = "mail.sidebar_highlighted_account", attrs = "theme_default" }
+"mail.sidebar_highlighted" = { fg = "Grey7", bg = "White", attrs = "theme_default" }
+"mail.sidebar_highlighted_index" = { fg = "mail.sidebar_index", bg = "mail.sidebar_highlighted", attrs = "theme_default" }
+"mail.sidebar_highlighted_unread_count" = { fg = "mail.sidebar_highlighted", bg = "mail.sidebar_highlighted", attrs = "theme_default" }
+"mail.sidebar_index" = { fg = "Grey46", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_unread_count" = { fg = "Grey46", bg = "theme_default", attrs = "theme_default" }
+"mail.view.body" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.view.headers" = { fg = "DodgerBlue1", bg = "theme_default", attrs = "theme_default" }
+"status.bar" = { fg = "White", bg = "#A21500", attrs = "theme_default" }
+"tab.bar" = { fg = "theme_default", bg = "#332300", attrs = "theme_default" }
+"tab.unfocused" = { fg = "theme_default", bg = "#A26F00", attrs = "theme_default" }
+"tab.focused" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
diff --git a/docs/samples/themes/watermelon.toml b/docs/samples/themes/watermelon.toml
new file mode 100644
index 00000000..45acb843
--- /dev/null
+++ b/docs/samples/themes/watermelon.toml
@@ -0,0 +1,48 @@
+[terminal.themes.watermelon]
+color_aliases = { "JewelGreen" = "#157241", "PinkLace" = "#FFD5FD", "TorchRed" = "#F50431", "ChelseaCucumber" = "#6CA94A", "ScreaminGreen" = "#8FFF52", "SunsetOrange" = "#f74b41", "Melon" = "#fdbcb4", "BlueStone" = "#005F5F", "HotPink" = "#FF74D7" }
+"theme_default" = { fg = "$TorchRed", bg = "$PinkLace", attrs = "Default" }
+"widgets.list.header" = { fg = "$PinkLace", bg = "$TorchRed", attrs = "Bold" }
+"mail.listing.attachment_flag" = { fg = "LightSlateGrey", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.tag_default" = { bg = "$Melon", attrs = "Bold" }
+"mail.listing.compact.even" = { fg = "White", bg = "$ChelseaCucumber", attrs = "Bold" }
+"mail.listing.compact.odd" = { fg = "$PinkLace", bg = "$JewelGreen", attrs = "theme_default" }
+"mail.listing.compact.even_unseen" = { fg = "$JewelGreen", bg = "$ScreaminGreen", attrs = "theme_default" }
+"mail.listing.compact.odd_unseen" = { fg = "$JewelGreen", bg = "$ScreaminGreen", attrs = "theme_default" }
+"mail.listing.compact.even_highlighted" = { fg = "$JewelGreen", bg = "$SunsetOrange", attrs = "theme_default" }
+"mail.listing.compact.odd_highlighted" = { fg = "$JewelGreen", bg = "$SunsetOrange", attrs = "theme_default" }
+"mail.listing.compact.even_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.compact.odd_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.conversations.date" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.from" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.highlighted" = { fg = "$JewelGreen", bg = "$SunsetOrange", attrs = "theme_default" }
+"mail.listing.conversations.padding" = { fg = "$TorchRed", bg = "Grey15", attrs = "theme_default" }
+"mail.listing.conversations.selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.conversations.subject" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.conversations.unseen" = { fg = "Black", bg = "mail.listing.compact.even_unseen", attrs = "theme_default" }
+"mail.listing.conversations.unseen_padding" = { fg = "$BlueStone", bg = "mail.listing.conversations.unseen", attrs = "theme_default" }
+"mail.listing.plain.even" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.odd" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.listing.plain.even_unseen" = { fg = "theme_default", bg = "mail.listing.compact.even_unseen", attrs = "theme_default" }
+"mail.listing.plain.odd_unseen" = { fg = "theme_default", bg = "mail.listing.compact.odd_unseen", attrs = "theme_default" }
+"mail.listing.plain.even_highlighted" = { fg = "$JewelGreen", bg = "$SunsetOrange", attrs = "theme_default" }
+"mail.listing.plain.odd_highlighted" = { fg = "$JewelGreen", bg = "$SunsetOrange", attrs = "theme_default" }
+"mail.listing.plain.even_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.plain.odd_selected" = { fg = "theme_default", bg = "LightCoral", attrs = "theme_default" }
+"mail.listing.thread_snooze_flag" = { fg = "Red", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_highlighted_account" = { fg = "White", bg = "$TorchRed", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_index" = { fg = "mail.sidebar_index", bg = "mail.sidebar_highlighted_account", attrs = "theme_default" }
+"mail.sidebar_highlighted_account_unread_count" = { fg = "mail.sidebar_unread_count", bg = "mail.sidebar_highlighted_account", attrs = "theme_default" }
+"mail.sidebar_highlighted" = { fg = "Grey7", bg = "White", attrs = "theme_default" }
+"mail.sidebar_highlighted_index" = { fg = "mail.sidebar_index", bg = "mail.sidebar_highlighted", attrs = "theme_default" }
+"mail.sidebar_highlighted_unread_count" = { fg = "mail.sidebar_highlighted", bg = "mail.sidebar_highlighted", attrs = "theme_default" }
+"mail.sidebar_index" = { fg = "Grey46", bg = "theme_default", attrs = "theme_default" }
+"mail.sidebar_unread_count" = { fg = "Grey46", bg = "theme_default", attrs = "theme_default" }
+"mail.view.body" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"mail.view.headers" = { fg = "DodgerBlue1", bg = "theme_default", attrs = "theme_default" }
+"status.bar" = { fg = "$PinkLace", bg = "$TorchRed", attrs = "theme_default" }
+"status.notification" = { fg = "theme_default", bg = "theme_default", attrs = "Default" }
+"tab.bar" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }
+"tab.unfocused" = { fg = "$PinkLace", bg = "$HotPink", attrs = "theme_default" }
+"tab.focused" = { fg = "theme_default", bg = "theme_default", attrs = "theme_default" }