From 597fd40812f0b53730ac80b326319e128a211931 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?juno=20su=C3=A1rez?= Date: Wed, 4 Nov 2020 09:53:51 -0800 Subject: [PATCH] docs(cmd_duration): Document cmd_duration notifications (#1831) * docs: add options for cmd_duration notifications Added in #1019 * Update docs/config/README.md Co-authored-by: Thomas O'Donnell Co-authored-by: Thomas O'Donnell --- docs/config/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/config/README.md b/docs/config/README.md index 49879f21..8d5876ff 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -496,6 +496,15 @@ running `eval $(starship init $0)`, and then proceed as normal. | `format` | `"took [$duration]($style) "` | The format for the module. | | `style` | `"bold yellow"` | The style for the module. | | `disabled` | `false` | Disables the `cmd_duration` module. | +| `show_notifications`| `false` | Show desktop notifications when command completes. | +| `min_time_to_notify`| `45_000` | Shortest duration for notification (in milliseconds). | + +::: tip + +Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship +supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. + +::: ### Variables