From 1714765941cc1291ff6d493d756e0d40e578cf02 Mon Sep 17 00:00:00 2001
From: Evy Bongers <evy@evybongers.nl>
Date: Thu, 7 Mar 2024 22:08:34 +0100
Subject: [PATCH] Get started with LEDControl documentation

Signed-off-by: Evy Bongers <evy@evybongers.nl>
---
 plugins/Kaleidoscope-LEDControl/README.md | 50 ++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/plugins/Kaleidoscope-LEDControl/README.md b/plugins/Kaleidoscope-LEDControl/README.md
index 675d2c9a67..a021c18611 100644
--- a/plugins/Kaleidoscope-LEDControl/README.md
+++ b/plugins/Kaleidoscope-LEDControl/README.md
@@ -1,6 +1,54 @@
 # Kaleidoscope-LEDControl
 
 This is a plugin for [Kaleidoscope][fw], for controlling the LEDs, and LED
-effects.
+effects. It is also a building block for plugins that control LEDs.
 
  [fw]: https://github.com/keyboardio/Kaleidoscope
+
+## Using the extension
+
+## Plugin methods
+
+### `.next_mode(void)`
+
+> Activates the next LED mode. cycles to the first LED mode if the current LED
+> mode is the last one.
+
+### `.prev_mode(void)`
+
+> Activates the previous LED mode. cycles to the last LED mode if the current
+> LED mode is the first one.
+
+### `.set_mode(uint8_t mode_id)`
+### `.get_mode_index()`
+### `.get_mode()`
+### `.refreshAll()`
+### `.setCrgbAt(uint8_t led_index, cRGB crgb)`
+### `.setCrgbAt(KeyAddr key_addr, cRGB color)`
+### `.getCrgbAt(uint8_t led_index)`
+### `.getCrgbAt(KeyAddr key_addr)`
+### `.syncLeds(void)`
+### `.set_all_leds_to(uint8_t r, uint8_t g, uint8_t b)`
+### `.set_all_leds_to(cRGB color)`
+### `.setSyncInterval(uint8_t interval)`
+### `.setBrightness(uint8_t brightness)`
+### `.getBrightness()`
+
+### `.onSetup()`
+### `.setup(void)`
+### `.onKeyEvent(KeyEvent &event)`
+### `.afterEachCycle()`
+### `.update(void)`
+
+> Triggers the currently active LED mode to update. It is up to the LED mode to
+> handle this correctly.
+
+### `.refreshAt(KeyAddr key_addr)`
+
+> Triggers the currently active LED mode to refresh the LED at the specified key
+> address.
+
+### `.activate(LEDModeInterface *plugin)`
+### `.disable()`
+### `.enable()`
+### `.isEnabled()`