diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 94 |
1 files changed, 0 insertions, 94 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index e92df6e..0000000 --- a/README.md +++ /dev/null @@ -1,94 +0,0 @@ -[](https://melpa.org/#/yeetube) - -# YeeTube - - -## About - -This package provides the ability to scrape YouTube, with the results -displayed in a proced-like buffer. - - -Package functionality includes: - -- Query YouTube -- Play video url *by default using mpv* -- Bookmark/Save video url -- Download video *using yt-dlp* -- A minimal yt-dlp front-end, *which is independent of the rest - YouTube functionality*. - -*This package does not use Invidious or YouTube's API, just "parses" -html & json.* - - -## Installation -This package is available via [MELPA](https://melpa.org/#/yeetube) - -### Straight.el - -``` emacs-lisp -(straight-use-package - '(yeetube :type git - :host nil - :repo "https://git.thanosapollo.org/yeetube")) -``` - - -### Manual -``` shell -$ git clone https://git.thanosapollo.org/yeetube -``` - -*Add this to your emacs configuration:* - -``` emacs-lisp - (add-to-list 'load-path "/path/to/yeetube") - (load-file "~/path/to/yeetube.el") - (require 'yeetube) -``` - -### Dependencies -- [mpv](https://mpv.io/): default multimedia player -- [yt-dlp](https://github.com/yt-dlp/yt-dlp): download functionality - -*Debian/Ubuntu* -``` shell -$ sudo apt install mpv yt-dlp -``` - -## Configuration -### Media Player -By default `yeetube-player` is set to `yeetube-mpv-play`, you can -use [mpv.el](https://github.com/kljohann/mpv.el), -[GNU/Emms](https://www.gnu.org/software/emms/) or other similar -packages like so: - -``` emacs-lisp -(setf yeetube-player #'emms-play-url) -``` - -Make sure that the media player of your choice can directly play -youtube urls. - -### Apply Filters - -To filter the search results based on a specific criterion, you can -modify the `yeetube-filter` value to your preferred option. - -For example: - -```emacs-lisp -(setf yeetube-filter "Views") -``` - -This will filter & sort the search results according to the number of views. - - -### FAQ -#### Feature request: display thumbnails -Formatting images in a text buffer is not something that I found easy -or fun to do. Feel free to submit a patch if you manage to make an -appealing version of it - - |