From 939ce7bfbc4cbcfc7d593a270cf41b3a4a9370e6 Mon Sep 17 00:00:00 2001
From: cyian-1756 <cyian-1756@users.noreply.github.com>
Date: Tue, 6 Mar 2018 06:55:20 -0500
Subject: [PATCH] Reformatted config options so they're easier to read

---
 Config-options.md | 144 ++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 120 insertions(+), 24 deletions(-)

diff --git a/Config-options.md b/Config-options.md
index 8b42506..2056041 100644
--- a/Config-options.md
+++ b/Config-options.md
@@ -9,52 +9,148 @@ $HOME/.config/ripme on *Nix
 
 $HOME/Library/Application Support/ripme on MacOS
 
-file.overwrite     | bool | If true ripme will overwrite existing files rather than skip them
+### file.overwrite
 
-clipboard.autorip  | bool | If true ripme will try to download any links in the clip board
+bool
 
-error.skip404      | bool | Don't retry on 404 errors
+If true ripme will overwrite existing files rather than skip them
 
-download.save_order| bool | If true ripme will prefix each downloaded file with a number in the order the file was download
+### clipboard.autorip
 
-auto.update        | bool | If true ripme will auto-update every time it's started
+bool
 
-tumblr.get_raw_image | bool | If true the tumblr ripper will download the image in the size it was uploaded in
+If true ripme will try to download any links in the clip board
 
-play.sound         | bool | If true ripme will play a sound every time a rip finishes
+### error.skip404
 
-download.show_popup| bool | TODO figure out what this is for
+bool
 
-log.save           | bool | If true ripme will save it's logs
+Don't retry on 404 errors
 
-urls_only.save     | bool | If true ripme will save all urls to a text file and download no files
+### download.save_order
 
-album_titles.save  | bool | Currently does nothing
+bool
 
-prefer.mp4         | bool | Prefer mp4 when downloading a video that has more than 1 format
+If true ripme will prefix each downloaded file with a number in the order the file was download
 
-history.warn_before_delete | bool | If true ripme will prompt the user with a "Are you sure?" box when clearing ripmes download history
+### auto.update
 
-instagram.download_images_only | bool | If true the instagram ripper will skip videos and only download images
+bool
 
-download.timeout   | int  | File download timeout (in milliseconds)
+If true ripme will auto-update every time it's started
 
-page.timeout       | int  | Page download timeout (in milliseconds)
+### tumblr.get_raw_image
 
-download.max_size  | int  | Maximum size of downloaded files in bytes
+bool
 
-threads.size       | int  | The number of threads to use
+If true the tumblr ripper will download the image in the size it was uploaded in
 
-twitter.max_requests | int | TODO figure out what this is for
+### play.sound
 
-history.end_rip_after_already_seen | int | The max number of times download a url will fail with "Already downloaded" before the rip stops.
+bool
 
-twitter.auth       | String | Twitter API key (Base64'd)
+If true ripme will play a sound every time a rip finishes
 
-tumblr.auth        | String | Tumblr API key
+### download.show_popup
 
-log.level          | String | The debug log level (Example: Log level: Debug)
+bool
 
-gw.api             | String | TODO figure out what this is for
+TODO figure out what this is for
+
+### log.save
+
+bool
+
+If true ripme will save it's logs
+
+### urls_only.save
+
+bool
+
+If true ripme will save all urls to a text file and download no files
+
+### album_titles.save
+
+bool
+
+Currently does nothing
+
+### prefer.mp4
+
+bool
+
+Prefer mp4 when downloading a video that has more than 1 format
+
+### history.warn_before_delete
+
+bool
+
+If true ripme will prompt the user with a "Are you sure?" box when clearing ripmes download history
+
+### instagram.download_images_only
+
+bool
+
+If true the instagram ripper will skip videos and only download images
+
+### download.timeout
+
+int
+
+File download timeout (in milliseconds)
+
+### page.timeout
+
+int
+
+Page download timeout (in milliseconds)
+
+### download.max_size
+
+int
+
+Maximum size of downloaded files in bytes
+
+### threads.size
+
+int
+
+The number of threads to use
+
+### twitter.max_requests
+
+int
+
+TODO figure out what this is for
+
+### history.end_rip_after_already_seen
+
+int
+
+The max number of times download a url will fail with "Already downloaded" before the rip stops.
+
+### twitter.auth
+
+String
+
+Twitter API key (Base64'd)
+
+### tumblr.auth
+
+String
+
+Tumblr API key
+
+### log.level
+
+String
+
+The debug log level (Example: Log level: Debug)
+
+### gw.api
+
+String
+
+TODO figure out what this is for