From d89ae3a2bc01675994e6f9174b1c72ad845a325c Mon Sep 17 00:00:00 2001 From: Duarte Dias Date: Tue, 9 Feb 2021 19:21:23 +0000 Subject: [PATCH] add keyboard shortcut information in readme.md --- readme.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/readme.md b/readme.md index 67f2a43..8939612 100644 --- a/readme.md +++ b/readme.md @@ -68,6 +68,26 @@ Then run one of the corresponding commands: # ... or build a docker image docker build -t yarr . +## keyboard shortcuts +:warning: These shortcuts are case-sensitive +### general +| key | action | +|-----|------------------------------| +| r | toggle item as read / unread | +| R | mark all items as read | +| s | star / unstar item | +| ? | focus the search bar | +| A | view All items | +| U | view Unread items | +| S | view Starred items | +### navigation (vim-like) +| key | action | +|-----|--------------------------| +| j | go to next feed item | +| k | go to previous feed item | +| l | go to next feed | +| h | go to previous feed | + ## credits [Feather](http://feathericons.com/) for icons.