aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Silas Bartha <[email protected]>2024-01-05 02:40:19 -0500
committerLibravatar Silas Bartha <[email protected]>2024-01-05 02:40:19 -0500
commitc89020d72145a1c432d98c040b306f7b2aa630c8 (patch)
tree252f8a8c7a1fc801d9dbbd4ec96a6d5893949c71
parent2de0122678495ec0c9108d20ad6fcb2edce8abb6 (diff)
Updated command usage info in README
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index eccbbfc..8eb6889 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,14 @@ cargo install --path .
Usage: pomc <COMMAND>
Commands:
- start
- pause
- stop
- skip
- get-iteration
- get-remaining
- is-running
- is-on-break
+ start Start the pomodoro timer
+ pause Pause the pomodoro timer
+ stop Stop the pomodoro timer
+ skip Skip the current timer
+ get-iteration Retrieve the current iteration of the pomodoro
+ get-remaining Get remaining timer duration (MM:SS)
+ is-running Get whether the timer is running
+ is-on-break Get whether the current timer is a break
help Print this message or the help of the given subcommand(s)
Options: