chore: update readme

f3rno64 · Dec 21, 2023 · 8a343cb · 8a343cb
1 parent c38f8f7
commit 8a343cb
Showing 1 changed file with 19 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -17,33 +17,43 @@ npm i -g track-time-cli
 ## Commands
 
 ```bash
-track-time-cli
+track-time-cli now
 
 Display all active time sheet entries
 
 Commands:
   track-time-cli in <description..>    Check in to a time sheet     [aliases: i]
   track-time-cli now                   Display all active time sheet entries
-                                                          [default] [aliases: n]
+                                                                       [default]
   track-time-cli out                   Check out of the currently active time
                                        sheet entry                  [aliases: o]
-  track-time-cli week                  Display a summary of activity for the
+  track-time-cli week [sheets..]       Display a summary of activity for the
                                        past week                    [aliases: w]
   track-time-cli list [sheets..]       List all time sheet entries  [aliases: l]
   track-time-cli edit [description..]  View, modify, or delete a time sheet
                                        entry                        [aliases: e]
-  track-time-cli today                 Display a summary of activity for today
+  track-time-cli today [sheets..]      Display a summary of activity for today
                                                                     [aliases: t]
-  track-time-cli sheet [name]          Switch to a sheet by name, creating it if
-                                       needed                       [aliases: s]
+  track-time-cli sheet [name]          Switch to or delete a sheet by name
+                                                                    [aliases: s]
   track-time-cli sheets                List all sheets             [aliases: ss]
   track-time-cli resume                Resume the last active entry [aliases: r]
-  track-time-cli yesterday             Display a summary of activity for
+  track-time-cli yesterday [sheets..]  Display a summary of activity for
                                        yesterday                    [aliases: y]
+  track-time-cli breakdown [sheets..]  Display total durations per day for one
+                                       or more sheets               [aliases: b]
 
 Options:
-  --help     Show help                                                 [boolean]
-  --version  Show version number                                       [boolean]
+      --version   Show version number                                  [boolean]
+  -h, --humanize  Print the total duration in human-readable format    [boolean]
+      --help      Show help                                            [boolean]
+
+Examples:
+  tt in --at "20 minutes ago" fixing a bug  Check in at a custom time
+  tt out --at "5 minutes ago"               Check out at a custom time
+  tt list --today --all                     View all entries from today
+  tt b                                      Show a breakdown of your activity
+  tt today --all                            View activity for the current day
 ```
 
 ## Usage