From 3bb61b976c6b777bc00026dae1603b5ad6fbae22 Mon Sep 17 00:00:00 2001 From: Devin Collins <3997333+ImDevinC@users.noreply.github.com> Date: Wed, 7 Jan 2026 22:10:59 -0800 Subject: [PATCH] docs: add action summaries to README Add comprehensive list of all available plugin actions with one-sentence descriptions to help users understand what each action does before configuring it. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 4008ddb..60f6023 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ streamcontroller official plugin to do OS Related actions +## Actions + +- **CPU**: Displays the current CPU usage percentage on the button. +- **CPU Temperature**: Shows the current CPU temperature in Celsius or Fahrenheit. +- **CPU Graph**: Displays a real-time graph of CPU usage over time. +- **RAM**: Displays the current RAM usage percentage on the button. +- **RAM Graph**: Displays a real-time graph of RAM usage over time. +- **Hotkey**: Execute custom keyboard shortcuts with precise control over key press and release timing. +- **Hotkey from text**: Execute keyboard shortcuts using simple text notation (e.g., "ctrl+c"). +- **Write Text**: Types out configured text automatically when the button is pressed. +- **Run Command**: Executes shell commands with options for displaying output and auto-running at intervals. +- **Easy Command**: Simple action to run a shell command when the button is pressed. +- **Launch**: Opens a selected application from your system's installed apps. +- **Open In Browser**: Opens a specified URL in your default web browser. +- **Click**: Simulates mouse clicks (left, middle, or right button). +- **Move XY**: Moves the mouse cursor to specific X and Y coordinates on the screen. +- **Delay**: Adds a configurable time delay between actions in a multi-action sequence. + ## Hotkeys & Write text Hotkeys and write text actions require you are in the input group and you have the following udev rule