diff --git a/.img/97bc905fa6f0ea31314aa4c7fae16d4883d555184f7e65d7f1e41cd6a389148c.png b/.img/97bc905fa6f0ea31314aa4c7fae16d4883d555184f7e65d7f1e41cd6a389148c.png new file mode 100644 index 0000000..5d8ec3b Binary files /dev/null and b/.img/97bc905fa6f0ea31314aa4c7fae16d4883d555184f7e65d7f1e41cd6a389148c.png differ diff --git a/Cargo.toml b/Cargo.toml index b5d045c..e84323c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "jisho-cli" description = "A simple cli tool to lookup Japanese words using jisho.org" -version = "0.1.4" +version = "1.0.0" authors = ["jojii ", "Hiers + # Installation Binaries are directly available from the release tab. @@ -17,12 +18,14 @@ cargo build --release ``` # Usage -A readline wrapper like `rlwrap` is strongly recommended if using `jisho-cli` interactively (-i). +A readline wrapper like `rlwrap` is strongly recommended if using `jisho-cli` interactively (-i or empty input). ``` jisho [] jisho :[] +jisho _[] ``` -When looking up radicals, * (or *) can be used to add a radical that can't be easily typed, e.g. 气. +When looking up kanji, * (or *) can be used to add a radical that can't be easily typed, e.g. 气. # Note -To search kanji by radicals, the [radkfile](https://www.edrdg.org/krad/kradinf.html) needs to be installed in either `~/.local/share/` on Linux or `~\AppData\Local\` on Windows. +To search kanji by radicals, the [radkfile](https://www.edrdg.org/krad/kradinf.html) needs to be installed in either `~/.local/share/` on Linux or `~\AppData\Local\ `on Windows. +Example sentences taken from [tatoeba](https://tatoeba.org/). diff --git a/src/main.rs b/src/main.rs index f53cced..72e005c 100644 --- a/src/main.rs +++ b/src/main.rs @@ -122,9 +122,10 @@ fn parse_args() -> aux::Options { let mut query_vec: Vec = Vec::new(); { let mut ap = ArgumentParser::new(); - ap.set_description("Use jisho.org from cli. \ + ap.set_description("Use jisho.org from the cli. \ Searching for kanji by radicals is also available if the radkfile file is installed in \"~/.local/share\" \ - or \"~\\AppData\\Local\\\" if you're on Windows."); + (linux) or \"~\\AppData\\Local\\\" (windows). \ + Additionally, searching for sentences in tatoeba is also possible."); ap.add_option( &["-V", "--version"], Print(env!("CARGO_PKG_VERSION").to_string()), @@ -138,7 +139,8 @@ fn parse_args() -> aux::Options { ap.refer(&mut query_vec) .add_argument("Query", List, "Search terms using jisho.org; Prepend it with ':' to search a kanji by radicals instead \ - and ':*' to search a radical by strokes (e.g. ':口*')."); + and ':*' to search a radical by strokes (e.g. ':口*'); \ + You can also use '_' to see example sentences from tatoeba."); ap.refer(&mut options.interactive).add_option( &["-i", "--interactive"],