From ca7604c279267cca4a4d3cc36838bc04ae2ceb85 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Sun, 29 Jun 2025 16:37:26 +0100 Subject: [PATCH] update --help in README --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7ecf775..1534536 100644 --- a/README.md +++ b/README.md @@ -74,20 +74,21 @@ simple-recorder --theme="Light Purple" ```shell Usage: simple-recorder [OPTIONS] COMMAND -┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ start Start recording ┃ -┃ stop Stop recording ┃ -┃ pause Pause recording ┃ -┃ resume Resume recording ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ start Start recording ┃ +┃ stop Stop recording ┃ +┃ pause Pause recording ┃ +┃ resume Resume recording ┃ +┃ directory Get or set the recording directory ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ -┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ --host OBS WebSocket host ┃ -┃ --port OBS WebSocket port ┃ -┃ --password OBS WebSocket password ┃ -┃ --theme GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach, ┃ -┃ Kayak, Light Blue 2) ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ --host OBS WebSocket host ┃ +┃ --port OBS WebSocket port ┃ +┃ --password OBS WebSocket password ┃ +┃ --theme GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach, ┃ +┃ Kayak, Light Blue 2) ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ``` To launch the CLI pass any subcommand (start/stop etc...), for example: