From 16affc04f5cb0475a8e4df71f173356eee468581 Mon Sep 17 00:00:00 2001 From: Paul Mabileau Date: Sat, 1 Jun 2024 00:19:35 +0200 Subject: [PATCH] Docs(README): Document displayed tables and their status icons Closes #12. Signed-off-by: Paul Mabileau --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2f1e2f6..1d0b701 100644 --- a/README.md +++ b/README.md @@ -282,6 +282,19 @@ $ cargo liner ``` +in which the first table displays each configured package's currently-installed +and most recent versions, along with the action that will be performed; the +second table shows an ending report displaying each touched package's previous +and new versions, along with the result of the call to `cargo install`. + +Status icons are optionally colored in the output and stand for the following: + * `ΓΈ`: when nothing to display or needs to be done: already up-to-date. + * `πŸ›ˆ`: when something needs to be performed: installation or update of a + package. + * `+`: when something was successfully added: new installation of a package. + * `✘`: when something failed. + * `βœ”`: when things went right: already up-to-date or successful update. + #### `ship` subcommand