Document Kconfig options

urob · Dec 15, 2024 · 6f0b8be · 6f0b8be
1 parent 6d30405
commit 6f0b8be
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/Kconfig b/Kconfig
@@ -5,7 +5,7 @@ config ZMK_LEADER_MAX_KEYS_PER_SEQUENCE
     default 5
 
 config ZMK_LEADER_MAX_SEQUENCES
-    int "Maximum number of leader sequences"
+    int "Maximum number of leader sequences per instance"
     default 32
 
 #Leader options

diff --git a/README.md b/README.md
@@ -111,6 +111,13 @@ ignored when evaluating sequences. For instance, if
 `ignore-keys = <LSHFT RSHFT>`, "shift" is passed through without triggering or
 terminating sequences.
 
+### `Kconfig` options
+
+- `CONFIG_ZMK_LEADER_MAX_KEYS_PER_SEQUENCE`: Maximum number of keys in a
+  sequence. Default is 5.
+- `CONFIG_ZMK_LEADER_MAX_SEQUENCES`: Maximum number of sequences per leader key
+  instance. Default is 32.
+
 ## References
 
 - The [legacy](https://github.com/urob/zmk-leader-key/tree/legacy) branch ports