Document Karabiner-Elements

README.md

@@ -43,7 +43,7 @@ $ config-update-all
 - [Git](https://git-scm.com/) - Version control. Configurations defined in [.config/git](.config/git). Dependencies managed as [submodules](.gitmodules).
 - [Hammerspoon](https://www.hammerspoon.org/) - Key bindings for managing macOS applications/windows. See [Hammerspoon](#hammerspoon).
 - [Homebrew](https://brew.sh/) - macOS package manager. [bundler](https://github.com/Homebrew/homebrew-bundle) manages packages [.config/Brewfile](.config/Brewfile). Local package dependencies managed by `.local/Brewfile` if it exists.
-- [Karabiner-Elements](https://pqrs.org/osx/karabiner/) - Custom key mappings for macOS. Configurations defined in [.config/karabiner](.config/karabiner).
+- [Karabiner-Elements](https://pqrs.org/osx/karabiner/) - Custom key mappings for macOS. See [Karabiner-Elements](#karabiner-elements).
 - [kitty](https://sw.kovidgoyal.net/kitty/) - Full-featured GPU-optimized terminal emulator with a readable [configuration file](.config/kitty).
 - [tmux](https://github.com/tmux/tmux) - Manages multiple terminal sessions, windows, and panes. Configured in [.tmux.conf](.tmux.conf).
 - [Vim](https://www.vim.org/)/[Neovim](https://neovim.io/) - Configurations setup primarily for [Neovim](https://neovim.io/) at [.config/nvim](.config/nvim). Compatibility with [Vim](https://www.vim.org/) is preserved by symlinking [.vim](.vim) and [.config/nvim/vimrc](.config/nvim/vimrc), and by ignoring [Neovim specific plugins](.config/nvim/bundles/nvim).
@@ -54,17 +54,27 @@ I use the [@sonph](https://github.com/sonph)'s [onehalfdark](https://github.com/
 
 [![Kitty (24-bit colors)](https://res.cloudinary.com/jawang35/image/upload/kitty-24-bit.png "Kitty (24-bit colors)")](https://res.cloudinary.com/jawang35/image/upload/kitty-24-bit.png)
 
+## Karabiner-Elements
+
+Custom [Karabiner-Elements](https://pqrs.org/osx/karabiner/) key bindings configured in [.config/karabiner](.config/karabiner) on macOS:
+
+- Left `ctrl` (or `fn`) with `h`, `j`, `k`, `l` for vi-like arrow movement.
+- Simultaneous `j` and `k` to escape.
+- `capslock` bound to `cmd+ctrl+option` to create a `hyper` key for use with [Hammerspoon](#hammerspoon).
+- `ctrl+delete` mimics `fn+delete` (delete forward).
+- Ducky (One 2/Mecha) Mini mappings to match Mac keyboard layout. VID/PID changed to work with macOS (https://twitter.com/i/status/1159519887527727106).
+
 ## Hammerspoon
 
 Lua scripts for [Hammerspoon](http://www.hammerspoon.org/) configuration. [.hammerspoon/init.lua](.hammerspoon/init.lua) is the entrypoint that loads all the other modules.
 
-`hyper` key is defined as `ctrl+option+cmd` and is bound to `capslock` using [Karabiner-Elements](.config/karabiner/karabiner.json). `hyper+r` reloads the Hammerspoon config.
+`hyper` key is defined as `ctrl+option+cmd` and is bound to `capslock` using [Karabiner-Elements](#karabiner-elements). `hyper+r` reloads the Hammerspoon config.
 
 ### Applications
 
 The following application shortcuts are used:
 
-| Key          | Application   |
+| Keys         | Application   |
 |:------------:| ------------- |
 | ``hyper+` `` | Kitty         |
 | `hyper+1`    | Google Chrome |
@@ -73,18 +83,18 @@ The following application shortcuts are used:
 
 `hyper+a` opens the application mode. `escape` closes the mode. With the mode open, the following keys launch or switch to the corresponding and close the mode:
 
-| Key       | Application       |
+| Keys      | Application       |
 |:---------:| ----------------- |
 | `hyper+m` | Messages          |
 | `hyper+o` | Microsoft Outlook |
 | `hyper+p` | 1Password         |
 | `hyper+s` | Slack             |
 
-### Windows
+### Window Management
 
 The following window shortcuts are used:
 
-| Key             | Action       |
+| Keys            | Action       |
 |:---------------:| ------------ |
 | `hyper+f`       | Full Screen  |
 | `hyper+c`       | Center       |