From 91562abde9ee36380a6dad159c973dab70f5128c Mon Sep 17 00:00:00 2001
From: xs5871 <xs5871@altlast.tk>
Date: Thu, 9 Dec 2021 20:01:22 +0000
Subject: [PATCH] update documentation

---
 docs/led.md | 35 +++++++++++++++++++++++++----------
 1 file changed, 25 insertions(+), 10 deletions(-)

diff --git a/docs/led.md b/docs/led.md
index be03a1e..1ac610f 100644
--- a/docs/led.md
+++ b/docs/led.md
@@ -2,29 +2,43 @@
 Want your keyboard to shine? Add some lights!
 
 ## Enabling the extension
-The only required values that you need to give the LED extension would be the 
-pixel pin, and the number of pixels/LED's. If using a split keyboard, this number
-is per side, and not the total of both sides.
+The only required values that you need to give the LED extension would be the
+`led_pin`. It can either be a single board pin, or a list of pins for multiple
+LED's.
 ```python
-from kmk.extensions.RGB import RGB
-from kb import led_pin  # This can be imported or defined manually
+from kmk.extensions.LED import LED
+import board
 
-led_ext = LED(led_pin=led_pin)
+led_ext = LED(led_pin=[board.GP0, board.GP1])
 keyboard.extensions.append(led_ext)
 ```
- 
+
 ## [Keycodes]
 
 |Key                          |Aliases            |Description                 |
 |-----------------------------|-------------------|----------------------------|
-|`KC.LED_TOG`                 |                   |Toggles LED's               |
-|`KC.LED_INC`                 |                   |Increase Brightness         |
-|`KC.LED_DEC`                 |                   |Decrease Brightness         |
+|`KC.LED_TOG()`               |                   |Toggles LED's               |
+|`KC.LED_INC()`               |                   |Increase Brightness         |
+|`KC.LED_DEC()`               |                   |Decrease Brightness         |
+|`KC.LED_SET()`               |                   |Set Brightness              |
 |`KC.LED_ANI`                 |                   |Increase animation speed    |
 |`KC.LED_AND`                 |                   |Decrease animation speed    |
 |`KC.LED_MODE_PLAIN`          |`LED_M_P`          |Static LED's                |
 |`KC.LED_MODE_BREATHE`        |`LED_M_B`          |Breathing animation         |
 
+Keycodes with arguments can affect all, or a selection of LED's.
+```python
+# toggle all LEDs
+LED_TOG_ALL = KC.LED_TOG()
+
+# increase brightness of first LED
+LED_INC_0   = KC.LED_INC(0)
+
+# decrease brightness of second and third LED
+LED_DEC_1_2 = KC.LED_DEC(1,2)
+
+```
+
 ## Configuration
 All of these values can be set by default for when the keyboard boots.
 ```python
@@ -36,6 +50,7 @@ led_ext = LED(
     breathe_center=1.5,
     animation_mode=AnimationModes.STATIC,
     animation_speed=1,
+    user_animation=None,
     val=100,
     )
 ```