diff --git a/README.md b/README.md index 46b9a83..d536cf4 100644 --- a/README.md +++ b/README.md @@ -170,12 +170,23 @@ as well as any function overloads, but these should be autocompleted through the Documentation for other branches can be reached at `https://pinnacle-comp.github.io/pinnacle/`. # Controls -The following controls are currently hardcoded: - -- Ctrl + Left click drag: Move a window -- Ctrl + Right click drag: Resize a window - -You can find the rest of the controls in the [`example_config`](api/lua/example_config.lua). +The following are the default controls in the [`example_config`](api/lua/example_config.lua). +| Binding | Action | +|----------------------------------------------|------------------------------------| +| Ctrl + Mouse left drag | Move window | +| Ctrl + Mouse right drag| Resize window | +| CtrlAlt + q | Quit Pinnacle | +| CtrlAlt + c | Close window | +| Ctrl + Return | Spawn [Alacritty](https://github.com/alacritty/alacritty) (you can change this in the config)| +| CtrlAlt + Space | Toggle between floating and tiled | +| Ctrl + f | Toggle fullscreen | +| Ctrl + m | Toggle maximized | +| Ctrl + Space | Cycle to the next layout | +| CtrlShift + Space | Cycle to the previous layout | +| Ctrl + 1 to 5 | Switch to tag `1` to `5` | +| CtrlShift + 1 to 5 | Toggle tag `1` to `5` | +| CtrlAlt + 1 to 5 | Move a window to tag `1` to `5` | +| CtrlAltShift + 1 to 5 | Toggle tag `1` to `5` on a window | # Feature Requests, Bug Reports, Contributions, and Questions See [`CONTRIBUTING.md`](CONTRIBUTING.md).