summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-06-25 23:35:34 +0300
committerPaul Buetow <paul@buetow.org>2025-06-25 23:35:34 +0300
commitc53a8c94d012db78ceab7d70698e3ae98f4d2968 (patch)
treef456c173d3f4b9277988c4a88c8dbd7e43528478 /README.md
parentc80437bf0edab6a11291f054bc7bad8873ce8885 (diff)
feat: Add fish shell integration
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 631134e..6d92f9f 100644
--- a/README.md
+++ b/README.md
@@ -29,3 +29,24 @@ sudo mv timr /usr/local/bin/
* `timr status`: Shows the current status of the timer (running or stopped) and the total elapsed time.
* `timr reset`: Resets the timer. This will set the elapsed time to zero.
* `timr live`: Shows a live, full-screen timer with keyboard controls (q: quit, s: start/stop, r: reset).
+
+## Fish Shell Integration
+
+`timr` can be integrated with the fish shell to display the current timer status in your prompt.
+
+### Installation
+
+1. Copy the `integrations/fish-shell` directory to your fish plugins directory:
+
+ ```bash
+ cp -r integrations/fish-shell ~/.config/fish/plugins/timr
+ ```
+
+2. Update your `fish_prompt` or `fish_right_prompt` function to include the `timr_prompt` function. For example, you can add the following to your `~/.config/fish/functions/fish_prompt.fish` file:
+
+ ```fish
+ function fish_prompt
+ # ... your existing prompt ...
+ printf ' %s' (timr_prompt)
+ end
+ ```