Add config file documentation in README

README.md

@@ -121,6 +121,50 @@ rip discover --list 'best-sellers'
 > - universal-jeunesse
 > - universal-chanson
 
+## The Config File
+
+This is where most of streamrip's functionality can be controlled. Here are
+the descriptions of the fields. They can also be found inside the file, which
+can be accessed with `rip config --open`.
+
+```yaml
+qobuz:
+        quality: '1: 320kbps MP3, 2: 16/44.1, 3: 24/<=96, 4: 24/>=96'
+        app_id: 'Do not change'
+        secrets: 'Do not change'
+    tidal:
+        quality: '0, 1, 2, or 3'
+        user_id: 'Do not change any of the fields below'
+        token_expiry: 'Tokens last 1 week after refresh. This is the Unix timestamp of the expiration time.'
+    deezer: "Deezer doesn't require login"
+        quality: '0, 1, or 2'
+    soundcloud:
+        quality: 'Only 0 is available'
+    database: 'This stores a list of item IDs so that repeats are not downloaded.'
+    filters: "Filter a Qobuz artist's discography. Set to 'true' to turn on a filter."
+        extras: 'Remove Collectors Editions, live recordings, etc.'
+        repeats: 'Picks the highest quality out of albums with identical titles.'
+        non_albums: 'Remove EPs and Singles'
+        features: 'Remove albums whose artist is not the one requested'
+        non_remaster: 'Only download remastered albums'
+    downloads:
+        folder: 'Folder where tracks are downloaded to'
+        source_subdirectories: "Put Qobuz albums in a 'Qobuz' folder, Tidal albums in 'Tidal' etc."
+    artwork:
+        embed: 'Write the image to the audio file'
+        size: "The size of the artwork to embed. Options: thumbnail, small, large, original. 'original' images can be up to 30MB, and may fail embedding. Using 'large' is recommended."
+        keep_hires_cover: 'Save the cover image at the highest quality as a seperate jpg file'
+    metadata: 'Only applicable for playlist downloads.'
+        set_playlist_to_album: "Sets the value of the 'ALBUM' field in the metadata to the playlist's name. This is useful if your music library software organizes tracks based on album name."
+        new_playlist_tracknumbers: "Replaces the original track's tracknumber with it's position in the playlist"
+    path_format: 'Changes the folder and file names generated by streamrip.'
+        folder: 'Available keys: "albumartist", "title", "year", "bit_depth", "sampling_rate", and "container"'
+        track: 'Available keys: "tracknumber", "artist", "albumartist", "composer", and "title"'
+    lastfm: 'Last.fm playlists are downloaded by searching for the titles of the tracks'
+        source: 'The source on which to search for the tracks.'
+    concurrent_downloads: 'Download (and convert) tracks all at once, instead of sequentially. If you are converting the tracks, and/or have fast internet, this will substantially improve processing speed.'
+```
+
 
 
 ## Troubleshooting

streamrip/config.py

@@ -213,8 +213,8 @@ class ConfigDocumentation:
     soundcloud:
         quality: Only 0 is available
     database: This stores a list of item IDs so that repeats are not downloaded.
-    filters: Filter a Qobuz artist's discography. Values set here will be applied every use, unless overrided by command line arguments.
+    filters: Filter a Qobuz artist's discography. Set to 'true' to turn on a filter.
-        extras: Collectors Editions, Live Recordings, etc.
+        extras: Remove Collectors Editions, live recordings, etc.
         repeats: Picks the highest quality out of albums with identical titles.
         non_albums: Remove EPs and Singles
         features: Remove albums whose artist is not the one requested
@@ -238,6 +238,7 @@ class ConfigDocumentation:
     """
 
     def __init__(self):
+        # not using ruamel because its super slow
         self.docs = []
         doctext = self.__doc__
         # get indent level, key, and documentation