aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2023-07-03 14:59:28 +0300
committerThanos Apollo <[email protected]>2023-07-03 15:05:48 +0300
commit0e862089d4cd4dff280aabb97c8b71f21dbced06 (patch)
tree28f3d8fbcfb55fb5ff01cc444c1d5df73b494dc9 /README.md
parent5098b6d75fdd802aa3feaeec3a29e47cb6e7a9ad (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7ca4b72..fc6184f 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,59 @@
## About
- Watch & Download Videos from Emacs.
+### But why?
+
+This was initially intended to simplify the expansion of my
+`~/Music`. However, as I delved into its development, the
+idea emerged to incorporate a different approach:
+
+**Enabling direct Search & Play of videos and audio within Emacs.**
+
+This circumvents the interruption of my "work-flow"" caused by
+diverting attention to external browsers and platforms like YouTube,
+which are attention black holes.
+
+
+### Customization
+- `yeetube-results-prefix` Default is "+"
+
+- `yeetube-query-url` Default is YouTube URL, soon there will be more sites
+supported
+
+- `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-player)
+```
+
+`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 it interactively.
+
+
## Installation
- Clone repo
@@ -20,6 +73,7 @@ git clone https://git.sr.ht/~thanosapollo/yeetube.el
## Contributing
- [Mailing list](https://lists.sr.ht/~thanosapollo/yeetube.el)
+ - Development takes places on `dev` branch
- [Issue Tracker](https://todo.sr.ht/~thanosapollo/yeetube.el)