Skip to content

Commit 703f52a

Browse files
authored
docs: beautify readme + add uses
1 parent f73b04d commit 703f52a

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,24 @@ git config --global pager.diff diffnav
5555

5656
## Keys
5757

58-
- <kbd>j</kbd>/<kbd>k</kbd> - navigate the file tree
59-
- <kbd>Ctrl-d</kbd>/<kbd>Ctrl-u</kbd> - navigate the diff
60-
- <kbd>e</kbd> - toggle the file tree
61-
- <kbd>q</kbd>/<kbd>Ctrl+c</kbd> - quit
58+
| Key | Description |
59+
|:-------------------|:--------------------------------|
60+
| <kbd>j</kbd> | Next file |
61+
| <kbd>k</kbd> | Previous file |
62+
| <kbd>Ctrl-d</kbd> | Scroll the diff down |
63+
| <kbd>Ctrl-u</kbd> | Scroll the diff up |
64+
| <kbd>e</kbd> | Toggle the file tree |
65+
| <kbd>q</kbd> | Quit |
66+
67+
## Under the hood
68+
69+
`diffnav` uses:
70+
71+
* [Bubble Tea](https://github.com/charmbracelet/bubbletea) for the TUI
72+
* [`delta`](https://github.com/dandavison/delta) for viewing the diffed file
73+
74+
Screenshots use:
75+
76+
* [kitty](https://sw.kovidgoyal.net/kitty/) for the terminal
77+
* [tokyonight](https://github.com/folke/tokyonight.nvim) for the color scheme
78+
* [CommitMono](https://www.nerdfonts.com/font-downloads) for the font

0 commit comments

Comments
 (0)