aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2023-09-28 10:50:25 +0300
committerThanos Apollo <[email protected]>2023-09-28 10:50:25 +0300
commit1714c15a5fc5e5946b2faa7a9f3f289ad7287d66 (patch)
treeaf3a79d53bc45aa69dbb071afe702d3e49a38669 /README.md
parent6ae0ef6adb755ffb654445ee8ef1d36963bf492d (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 9 insertions, 13 deletions
diff --git a/README.md b/README.md
index 5173923..5ddef80 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,25 @@
# Yeetube.el
- [![MELPA](https://melpa.org/packages/yeetube-badge.svg)](https://melpa.org/#/yeetube) [![builds.sr.ht status](https://builds.sr.ht/~thanosapollo/yeetube.el.svg)](https://builds.sr.ht/~thanosapollo/yeetube.el?)
+ [![MELPA](https://melpa.org/packages/yeetube-badge.svg)](https://melpa.org/#/yeetube)
## About
-- YouTube & Invidious Front-End for Emacs.
+- Emacs YouTube Front-End
-This package provides the ability to scrape YouTube or any Invidious
-instance, with the results displayed in a read-only org-mode buffer.
+This package provides the ability to scrape YouTube, with the results
+displayed in a proced-like buffer.
## Installation
You can install it via [MELPA](https://melpa.org/#/yeetube)
*Or directly from source*
-- Download the latest tar-archive or clone the repo
-
``` shell
-git clone https://git.sr.ht/~thanosapollo/yeetube.el
-```
-
-- Load `yeetube.el`
+# Get yeetube using git
+git clone https://git.thanosapollo.com/yeetube
-``` emacs-lisp
+# Load yeetube
+(add-to-list 'load-path "/path/to/yeetube")
(load-file "~/path/to/yeetube.el")
```
-
### Dependencies
- [mpv](https://mpv.io/): default multimedia player
- [yt-dlp](https://github.com/yt-dlp/yt-dlp): download functionality
@@ -39,5 +35,5 @@ By default `yeetube-player` is set to `yeetube-mpv`, 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
-(setq yeetube-player 'emms-play-url)
+(setf yeetube-player 'emms-play-url)
```