From 8612391df4915ddc52a399afb9a85a18eef62928 Mon Sep 17 00:00:00 2001
From: Salt <rehashedsalt@cock.li>
Date: Thu, 26 Sep 2019 17:53:51 -0500
Subject: [PATCH] Overhaul README

---
 README.md | 41 ++++++++++++++++++++++++++++++++++-------
 1 file changed, 34 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index b343a32..c174a0b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # ptgdp: Play the Goddamned Playlist
 
-A tool to play a plaintext playlist composed entirely of youtube-dl search queries
+A tool to play a plaintext playlist composed entirely of youtube-dl search queries or URLs
 
 ## Installation
 
@@ -8,11 +8,12 @@ Put `ptgdp` somewhere in `$PATH` and install youtube-dl. Additionally, you need
 
 ## Quickstart
 
-Make a file containing a few download queries. For example:
+Make a file containing some download queries. For example:
 
     myplaylist
 
 ```
+nine inch nails play the goddamned part
 alice in chains love hate love
 megadeth high speed dirt
 tool parabola
@@ -22,7 +23,7 @@ Then invoke `ptgdp`:
 
     ptgdp myplaylist
 
-See below for more intricate usage.
+See `ptgdp -h` and the sections below for more intricate usage.
 
 ## Configuration
 
@@ -38,10 +39,36 @@ Move `ptgdp.conf` from this repo to `~/.config/ptgdp.conf` and change the values
 | `60` | Playlist does not exist |
 | `61` | Playlist is unreadable |
 
-## Idiosyncracies
+## Usage Tips
 
-* Because I haven't quite figured out how to into mpd sockets, this tool assumes that `$XDG_MUSIC_DIR` (`~/Music`) is the root of your library.
+* `ytsearch:` is only the *default* search. If a line is prefixed with another search type (ex. `scsearch:dagoth ur fanfiction`), youtube-dl will respect it.
 
-## License
+* You can use URLs if you want to.
 
-See `LICENSE` (hint: it's MIT, just like the header says).
+* You can comment a playlist file by prefixing the line with `#`.
+
+## FAQ
+
+**Q**: Why?
+
+**A**: I wanted to kick my dependence on Spotify while still having access to easy music. At first I just used YouTube, but after fighting their horrid suggestions system, I decided it probably wouldn't be too hard to use `youtube-dl` to wrap it. Thus this tool was born.
+
+Simple plaintext playlist files and a rofi script to queue them up with only a couple keystrokes seemed like a convenient enough implementation to me.
+
+**Q**: Holy fuck ow my disk space
+
+**A**: Songs are stored in ~/Music/PTGDP Songs. Clean it up if it gets too big; they'll be redownloaded as needed. Songs are cached both for offline usage and because YouTube searches aren't exactly the most consistent things over time.
+
+On the bright side, though, youtube-dl downloads most songs in Opus, which has insane quality per byte.
+
+**Q**: Why is your tool downloading the shitty "w/ lyrics" versions of songs with ass quality?
+
+**A**: Because YouTube searches suck. That being said, they will also parse out descriptions, so you can stick the copyright text or something in your search query. Alternatively, find a good video and just stick the URL in your playlist.
+
+**Q**: Why isn't my music player supported?
+
+**A**: Open a bug report/pull request.
+
+## Bugs
+
+* Because I haven't quite figured out how to into mpd sockets, this tool assumes that `$XDG_MUSIC_DIR` (`~/Music`) is the root of your library when using the mpd backend.