Add documentation about new hook to readme

pull/365/head
James N. V. Cash 7 years ago
parent 6dcc6a9277
commit e4cf2e4c75

@ -67,8 +67,8 @@ The plugin provides the `EEPROMKeymap` object, which has the following methods:
## Focus commands ## Focus commands
The plugin provides two `Focus` hooks: `FOCUS_HOOK_KEYMAP`, and The plugin provides three `Focus` hooks: `FOCUS_HOOK_KEYMAP`, `FOCUS_HOOK_KEYMAP_LAYER`,
`FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands and `FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands
available, respectively: available, respectively:
### `keymap.map [codes...]` ### `keymap.map [codes...]`
@ -81,6 +81,13 @@ available, respectively:
> layer, and go on as long as it has input. It will not go past the layer set > layer, and go on as long as it has input. It will not go past the layer set
> via the `.max_layers()` method. > via the `.max_layers()` method.
### `keymap.layer LAYER [codes...]`
> Without codes, prints the keymap for the given layer (zero-indexed).
> Prints each key as its raw 16-bit keycode.
> With codes, stores them as the keymap for the given layer.
### `keymap.transfer LAYER` ### `keymap.transfer LAYER`
> Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM` > Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM`

Loading…
Cancel
Save