Browse Source

readme: add keybindings

Benton Edmondson 1 year ago
parent
commit
9d13a78412
1 changed files with 22 additions and 2 deletions
  1. 22 2
      readme.md

+ 22 - 2
readme.md

@@ -1,6 +1,6 @@
 # Servitor
 
-A command line, RSS-style reader for the fediverse.
+A command line, RSS-style ActivityPub client that works with Mastodon, Lemmy, PeerTube, and more.
 
 ![](/assets/demo.gif)
 
@@ -85,7 +85,27 @@ hook = [
 ]
 ```
 
-`media.hook` defaults to `["xdg-open", "%url"]`. 
+`media.hook` defaults to `["xdg-open", "%url"]`.
+
+## Keybindings
+
+### Navigation
+`j` — move down\
+`k` — move up\
+space — select the highlighted item\
+`c` — view the creator of the highlighted item\
+`r` — view the recipient of the highlighted item (e.g. the group it was posted to)\
+`a` — view the actor of the activity (e.g. view the retweeter of a retweet)\
+`h` — move back in your browser history\
+`l` — move forward in your browser history\
+`g` — move to the expanded item (i.e. move to the current OP)\
+`ctrl+c` — exit the program
+
+### Media
+`p` — open the highlighted user's profile picture\
+`b` — open the highlighted user's banner\
+`o` — open the content of a post itself (e.g. open the video associated with a video post)\
+number keys — open a link within the highlighted text
 
 # Where to Find Content to Follow