aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 23 insertions, 16 deletions
diff --git a/README.md b/README.md
index b127af3..a817e3f 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,9 @@ Livie allows the user to search youtube.com and play the video from `mpv`.
## Installation
``` emacs-lisp
-(require 'livie "~/.emacs.d/path/to/livie.el")
+(push (concat user-emacs-directory "path/to/livie") load-path)
+(let* ((file-name-handler-alist nil))
+ (require 'livie))
```
## Installation in emacs-personal
@@ -33,21 +35,26 @@ Clone repo:
Open `settings.el` write the following:
``` emacs-lisp
-(require 'livie "~/.emacs.d/private/livie/livie.el")
+(push (concat user-emacs-directory "private/livie") load-path)
+(let* ((file-name-handler-alist nil))
+ (require 'livie))
```
## Usage
-Just run `M-x livie` and enter a search query. `n`, `p` and `tab`
-can be used to navigate the buffer.
-
-| key | binding |
-|-------------------|------------------------------|
-| <key>n</key> | `next-line` |
-| <key>p</key> | `previous-line` |
-| <key>q</key> | `livie-quit` |
-| <key>s</key> | `livie-search` |
-| <key>></key> | `livie-search-next-page` |
-| <key><</key> | `livie-search-previous-page` |
-| <key>return</key> | `livie-watch-this-video` |
-
-Type `s` to enter another search. To watch a video, press `<enter>`.
+Just run `M-x livie` and enter a search query.
+Puts it in `livie-mode`. Some of the ways you can interact
+with the buffer are shown below.
+
+| key | binding | description |
+|----------------|------------------------------|-------------------------------------------------------|
+| <kbd>n</kbd> | `next-line` | Move cursor to next line |
+| <kbd>p</kbd> | `previous-line` | Move cursor to previous line |
+| <kbd>q</kbd> | `livie-quit` | Bury the `*livie*` buffer |
+| <kbd>s</kbd> | `livie-search` | Make a new search |
+| <kbd>></kbd> | `livie-search-next-page` | Go to next page |
+| <kbd><</kbd> | `livie-search-previous-page` | Go to previous page |
+| <kbd>t</kbd> | `livie-search-type` | Change the type of results (videos, playlists, etc.). |
+| <kbd>S</kbd> | `livie-sort-videos` | Sort videos on the current buffer. |
+| <kbd>Y</kbd> | `livie-yank-channel-feed` | Copy the channel RSS feed for the current entry |
+| <kbd>RET</kbd> | `livie-open-entry` | Open entry |
+| <key>y</key> | `livie-watch-this-video` | Play video |