diff --git a/README.md b/README.md index 134ac61..3035955 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,25 @@ obs-cli is a simple cli tool for planned OBS recordings. ## Usage * `-s`, `--start-minutes` ``: Define the minutes where the recording should start [default: 0] * `-d`, `--duration-minutes` ``: Define the duration of the recording in minutes [default: 1] +* `-b`, `--begin-time` ``: Define the start time in HH:MM format +* `-e`, `--end-time` ``: Define the end time in HH:MM format * `-p`, `--poweroff`: Flag to shutdown the machine after recording * `-h`, `--help`: Print help information * `-V`, `--version`: Print version information + +### Examples +Use minutes to input durations. The following command will start a 60min long recording in 10 minutes. +```sh +./obs-cli -s 10 -d 60 +``` + +Another option is to use time strings in `HH:MM` format. +The following command will trigger a 30min long recording starting at 14:00. +```sh +./obs-cli -b 14:00 -e 14:30 +``` + +These two formats can be used together: +```sh +./obs-cli -b 14:00 -d 30 +```