From 49077b3a213461d2c7d97b1123f75c44722fc4e9 Mon Sep 17 00:00:00 2001 From: Thanos Apollo Date: Wed, 4 Oct 2023 09:26:06 +0300 Subject: Update README - Add melpa link - Add FAQ - Update configuration instructions --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f6a58c2..48b2bca 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,28 @@ -# Yeetube +[![MELPA](https://melpa.org/packages/yeetube-badge.svg)](https://melpa.org/#/yeetube) + +# Yeetube | Emacs' Youtube Front End ## About -- Emacs YouTube Front-End This package provides the ability to scrape YouTube, with the results displayed in a proced-like buffer. -*Inspired by [ytfzf](https://github.com/pystardust/ytfzf) & [ytel](https://github.com/grastello/ytel)* +Package functionality includes: + +- Search Youtube for query +- 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*, to download multiple urls. + +*Inspired by [ytfzf](https://github.com/pystardust/ytfzf) & [ytel](https://github.com/grastello/ytel)* -*This package does not use Invidious or YouTube's API* +*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 @@ -46,9 +56,21 @@ sudo apt install mpv yt-dlp ### Configuration #### Media Player -By default `yeetube-player` is set to `yeetube-mpv`, you can use +By default `yeetube-player` is set to `yeetube-mpv-play-url`, 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) +(setf yeetube-player #'emms-play-url) ``` + +Make sure that the media player of your choice can directly play youtube urls. + +### 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 + +#### Why did you make this +- Because it's fun +- To learn elisp +- Find a way to get youtube content without relying on external services, such as invidious. + -- cgit v1.2.3