aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2023-07-07 09:27:14 +0300
committerThanos Apollo <[email protected]>2023-07-07 09:27:14 +0300
commit55a621164176810d170fcc7e053de9da8dba31a7 (patch)
tree59f3710584f4b934546bdd079fd0b6b9f5295b75 /README.md
parent7cefb9f141041b4e263db0531a7a948eb280773f (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md68
1 files changed, 8 insertions, 60 deletions
diff --git a/README.md b/README.md
index dacc1f0..f4cb6b7 100644
--- a/README.md
+++ b/README.md
@@ -2,82 +2,30 @@
[![Sourcehut](https://img.shields.io/badge/master-sourcehut-black?logo=sourcehut)](https://git.sr.ht/~thanosapollo/yeetube.el)
## About
-- YouTube & Invidious Front-End.
+- YouTube & Invidious Front-End for Emacs.
Search for videos, download them, or just play them using your favorite multimedia player *by default mpv*
*All without leaving Emacs*
-It's time to *yeet* your browser.
-### But why?
+## Installation
-Because Emacs.
+- Download the latest tar-archive or cloe the repo
-#### Differences with other front-ends:
-- No YouTube/Invidious API
-- Includes a simple front-end for `yt-dlp` *not forcing you to use youtube/invidious urls* :)
-
-## Installation
-
-- Clone repo
-``` bash
-git clone https://git.sr.ht/~thanosapollo/yeetube.el
+``` shell
+git clone https://git.sr.ht/~thanosapollo/yeetube.el
```
-- Add the following to your `init.el`
+- Load `yeetube.el`
``` emacs-lisp
-(load-file "/path/to/yeetube.el"))
+(load file "~/path/to/yeetube.el")
```
-### Customization
-- `yeetube-results-prefix` Default is "+"
-
-- `yeetube-query-url` Default is youtube.com, *you can also use any invidious instance or localhost.*
- - [Invidious instances](https://docs.invidious.io/instances/)
-
-- `yeetube-download-audio-format` Default is `nil`, you can use it to
-specify your downloads to be only (audio) FORMAT, e.g "m4a"
-
-- `yeetube-display-info-keys` Default is `t`, displays default keybindings
-
-- `yeetube-player` Default is "mpv"
-
-#### Tips & Tricks
-
-You can easily define functions to execute your preferred
-`yeetube-player` while incorporating different user flags.
-
-For instance, a function to switch between `mpv` and `mpv --no-video`
-that allows for audio-only playback when desired.
-
-``` emacs-lisp
- (defun yeetube-switch-mpv ()
- "Switching mpv from/to only audio."
- (interactive)
- (if (equal yeetube-player "mpv")
- (setq yeetube-player "mpv --no-video")
- (setq yeetube-player "mpv")))
-```
-Add it as a keybinding to `yeetube-mode-map`
-
-``` emacs-lisp
-(define-key yeetube-mode-map (kbd "c") 'yeetube-switch-mpv)
-```
-#### Downloading non-Youtube links
-
-`yeetube-download-videos` is not specific to YouTube, it's just a
-front end for `yt-dlp`. Open a Dired buffer and navigate to your
-desired *PATH* and run `yeetube-download-videos` interactively.
-
-
## Contributing
- [Mailing list](https://lists.sr.ht/~thanosapollo/yeetube.el)
- - Development takes places on `dev` branch
+ - Development takes places on `dev` branch
- [Issue Tracker](https://todo.sr.ht/~thanosapollo/yeetube.el)
-
-
-