docs: update README

2026-07-28 15:28:49 -05:00
parent 71f261f6d8
commit 7461dee12c
1 changed files with 14 additions and 3 deletions
@@ -7,6 +7,8 @@ A minimal and unintrusive Pomodoro timer written in Rust for the terminal.
 - Supports focus sessions and break sessions.
 - System-level alerts to notify you when a session ends.
 - Define custom focus and break session durations from the command line.
+- Cross-platform sound notifications when a session ends.
+- Cross-platform audio visualizer.

 ## Keyboard Controls

@@ -52,7 +54,7 @@ termato

 ### Specifying Options and Custom Session Times

-By default, desktop notifications are disabled. You can specify options and custom session durations as command-line arguments:
+By default, desktop notifications, sound alerts, and the visualizer are disabled. You can specify options and custom session durations as command-line arguments:

 ```bash
 termato [options] [work_minutes] [break_minutes]
@@ -64,10 +66,19 @@ For example, to enable desktop notifications and run a 50-minute focus session f
 termato -n 50 10
 ```

-Or using the long flag:
+To enable both desktop notifications and sound notifications with custom times:

 ```bash
-termato --notify 50 10
+termato -ns 50 10
+
+# or with long flags
+termato --notify -sound 50 10
+```
+
+You can also combine short flags together (e.g. -nsz to enable notifications, sound, and the audio visualizer):
+
+```bash
+termato -nsz
 ```

 ### Help and Version