From 6d0288f4928f953bdee7d07908d8a4b816e61fc2 Mon Sep 17 00:00:00 2001
From: Devin Collins <3997333+ImDevinC@users.noreply.github.com>
Date: Wed, 7 Jan 2026 21:46:30 -0800
Subject: [PATCH] docs: add README with plugin overview and actions breakdown

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..625c639
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Deck Plugin
+
+Control your deck - Change the brightness, pages, etc.
+
+This plugin provides essential controls for managing your StreamController deck, including navigation, display settings, and state management.
+
+## Actions
+
+### Change Page
+Switch to a specific page on your deck with optional return timeout functionality.
+
+### Change State
+Navigate to a specific state on the current input with optional auto-return feature.
+
+### Go To Sleep
+Activate the deck's screen saver to put the deck to sleep.
+
+### Set Brightness
+Set the deck's screen brightness to a specific percentage value (0-100%).
+
+### Adjust Brightness
+Increase or decrease the deck's brightness by a specified amount with configurable minimum brightness limits.
+
+## Installation
+
+This plugin can be installed through the StreamController plugin store.
+
+## Requirements
+
+- StreamController version 1.0.0 or higher
+- For Change State action: StreamController version 1.5.0-beta.5 or higher
+
+## License
+
+See [LICENSE](LICENSE) file for details.
+
+## Repository
+
+https://github.com/StreamController/DeckPlugin