diff --git a/README.md b/README.md index 212abec..2083ad8 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) - [Installation](#installation) - [Configuration](#configuration) +- [Style](#style) - [Commands](#root-typer) - [License](#license) @@ -68,6 +69,37 @@ OBS_PASSWORD= Flags can be used to override environment variables. +## Style + +Styling is opt-in, by default you will get a colourless output: + +![colourless](./img/colourless.png) + +You may enable styling with the --style/-s flag: + +```console +obsws-cli --style="cyan" sceneitem list +``` + +Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_ + +![coloured](./img/coloured-border.png) + +Optionally you may disable border colouring with the --no-border flag: + +![coloured-no-border](./img/coloured-no-border.png) + +```console +obsws-cli --style="cyan' --no-border sceneitem list +``` + +Or with environment variables: + +```env +OBS_STYLE=cyan +OBS_STYLE_NO_BORDER=true +``` + ## Root Typer - obs-version: Get the OBS Client and WebSocket versions. @@ -628,34 +660,6 @@ obsws-cli projector open --monitor-index=1 "test_group" obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png" ``` -## Style - -By default styling is disabled but you may enable it with: - -- --style/-s: Style used in output. - - OBS_STYLE -- --no-border/-b: Disable table border styling in output. - - OBS_STYLE_NO_BORDER - -Available styles: - -- red -- magenta -- purple -- blue -- cyan -- green -- yellow -- orange -- white -- grey -- navy -- black - -```console -obsws-cli --style=cyan --no-border scene list -``` - ## License `obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. diff --git a/img/coloured-border.png b/img/coloured-border.png new file mode 100755 index 0000000..4a971e9 Binary files /dev/null and b/img/coloured-border.png differ diff --git a/img/coloured-no-border.png b/img/coloured-no-border.png new file mode 100755 index 0000000..e7df263 Binary files /dev/null and b/img/coloured-no-border.png differ diff --git a/img/colourless.png b/img/colourless.png new file mode 100755 index 0000000..40fd10e Binary files /dev/null and b/img/colourless.png differ