From 3d8ef1b4dd80a94df4093236bd2e0b23dee9241b Mon Sep 17 00:00:00 2001 From: Thanos Apollo Date: Tue, 1 Aug 2023 16:52:12 +0300 Subject: Update README --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f53e63d..abc1e81 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,22 @@ # Yeetube.el [![builds.sr.ht status](https://builds.sr.ht/~thanosapollo/yeetube.el.svg)](https://builds.sr.ht/~thanosapollo/yeetube.el?) + +Available via [![MELPA](https://melpa.org/packages/yeetube-badge.svg)](https://melpa.org/#/yeetube) ## About - YouTube & Invidious Front-End for Emacs. -Search for videos, download them, or just play them using your favorite multimedia player *by default mpv* +This package provides the ability to scrape YouTube or any Invidious +instance, with the results displayed in a read-only org-mode buffer. + +Key features: + - Search video query + - Play video URL, *by default with MPV* + - Save video URL with a custom name/label + - Download video, *this package serves also as a front-end for + yt-dlp, thus supporting platforms beyond YouTube/Invidious.* -*All without leaving Emacs* ## Installation @@ -26,7 +35,8 @@ git clone https://git.sr.ht/~thanosapollo/yeetube.el (load-file "~/path/to/yeetube.el") ``` -- Make sure you have installed `mpv` and `yt-dlp` as well + +Install `mpv` & `yt-dlp` *Debian/Ubuntu* ``` shell sudo apt install yt-dlp mpv -- cgit v1.2.3