diff --git a/README.md b/README.md index eaea437..ef54e18 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Tuimail -Tuimail is a terminal email client. It allowes you to use your keyboard to navigate, search and send messages. +Tuimail is a terminal email client. It allows you to use your keyboard to navigate, search and send messages. ### Safety features - no html rendering (conversion to plain text) @@ -14,22 +14,25 @@ Tuimail is a terminal email client. It allowes you to use your keyboard to navig # Configuring Sorry, there is no binary release for now. This setup requires that you have rust cargo installed. -Run the setup wizard: +```bash +cargo run +``` +The first time you run it asks you to enter the config settings. +You can reconfigure later using: ```bash cargo run -- --configure ``` -(the first time --configure is active by default) When prompted for provider choose `imap/proton`, choose your provider: -For Imap: +For imap using gmail: - IMAP host: `imap.gmail.com`, port: `993`, TLS: `true` - Username - Password - SMTP host: `smtp.gmail.com`, port: `465`, TLS mode: `smtps` -Different mail providers may use other hosts and ports. +Different imap providers may have other hosts and ports... For Proton (Tuimail does not require the proton-bridge) - Username: your proton account user name