From eddda553a4660c1a41775ab8a60492192d8a55de Mon Sep 17 00:00:00 2001 From: Devin Collins <3997333+ImDevinC@users.noreply.github.com> Date: Wed, 7 Jan 2026 22:13:40 -0800 Subject: [PATCH] docs: Add comprehensive action descriptions to README Add detailed one-sentence descriptions for all plugin actions to improve documentation and help users understand the functionality of each action in the VolumeMixer plugin. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d61973d..ed70c50 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ # VolumeMixer + +A StreamController plugin for managing audio volumes through PulseAudio. + +## Actions + +- **OpenVolumeMixer**: Opens the volume mixer interface page and allows configuring the volume increment percentage. +- **ExitVolumeMixer**: Exits the volume mixer interface and returns to the previous page. +- **MoveLeft**: Navigates left to view additional audio inputs when more inputs exist than can be displayed at once. +- **MoveRight**: Navigates right to return to previously viewed audio inputs in the volume mixer. +- **VolumeUpKey**: Increases the volume of the associated audio input by the configured increment amount. +- **VolumeDownKey**: Decreases the volume of the associated audio input by the configured increment amount. +- **MuteKey**: Toggles the mute state of the associated audio input. +- **Dial**: Controls audio input volume via dial rotation and toggles mute with a short press (for Stream Deck Plus). \ No newline at end of file