From d94b86ca4e4536921786098da1a58c5f9505759f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20DOUIN?= Date: Sun, 3 Jan 2021 00:49:51 +0100 Subject: [PATCH] add help entry to readme --- Cargo.toml | 2 +- README.md | 29 +++++++++++++++++++++++++++-- src/main.rs | 2 +- 3 files changed, 29 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 783b944..d4cd95a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "himalaya" -description = "📫 Minimalist CLI mail client" +description = "📫 Minimalist CLI email client" version = "0.1.0" authors = ["soywod "] edition = "2018" diff --git a/README.md b/README.md index fe00adb..3b74611 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# Himalaya +# 📫 Himalaya -📫 Minimalist CLI mail client, written in Rust. +Minimalist CLI email client, written in Rust. + +```bash +himalaya --help +``` + +```help +Himalaya 0.1.0 +soywod +📫 Minimalist CLI email client + +USAGE: + himalaya [SUBCOMMAND] + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +SUBCOMMANDS: + forward Forwards an email by its UID + help Prints this message or the help of the given subcommand(s) + query Prints emails filtered by the given IMAP query + read Reads an email by its UID + reply Replies to an email by its UID + write Writes a new email +``` diff --git a/src/main.rs b/src/main.rs index 3ea5377..415cd07 100644 --- a/src/main.rs +++ b/src/main.rs @@ -24,7 +24,7 @@ fn main() { let matches = App::new("Himalaya") .version("0.1.0") - .about("📫 Minimalist CLI mail client") + .about("📫 Minimalist CLI email client") .author("soywod ") .subcommand( SubCommand::with_name("read")