diff --git a/CHANGELOG.md b/CHANGELOG.md index 06e9263d..e7aa8ecd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ All notable user-visible changes to Hunk are documented in this file. ### Added +- Added a GitHub-facing keyboard shortcuts section to the README. + ### Changed ### Fixed diff --git a/README.md b/README.md index 401c5ce0..6401a405 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,37 @@ hunk # show help hunk --version # print the installed version ``` +## Keyboard shortcuts + +Press `?` in Hunk to open the full in-app controls help. + +### Navigation + +- `↑` / `↓` or `j` / `k` — move line by line +- `Space` / `f` / `PageDown` — page down +- `b` / `PageUp` / `Shift+Space` — page up +- `d` / `u` — half page down / up +- `Home` / `End` — jump to top / bottom +- `[` / `]` — previous / next hunk +- `{` / `}` — previous / next comment +- `←` / `→` — scroll code horizontally (`Shift+←` / `Shift+→` for faster scrolling) + +### View + +- `1` / `2` / `0` — split / stack / auto layout +- `s` — toggle sidebar +- `t` — cycle theme +- `a` — toggle AI notes +- `l` / `w` / `m` — line numbers / wrap / metadata + +### Review + +- `/` — focus file filter +- `Tab` — toggle files/filter focus +- `F10` — open menus +- `r` — reload, when supported +- `q` / `Esc` — quit + ### Working with Git Hunk mirrors Git's diff-style commands, but opens the changeset in a review UI instead of plain text.