Merge pull request #507 from dabutvin/update-docs-with-wiki-support

Updated docs regarding wiki compression

Docs/compress-wiki.md

@@ -0,0 +1,20 @@
+# Compress Wiki
+
+If your repository has a wiki with images, you can opt in to optimize these images as well as your code repo.
+
+All of the images in the wiki will be updated directly on the default branch. This is due to the lack of branch management and no pull requests available within GitHub wikis.
+
+By adding `compressWiki` in the `.imgbotconfig` file as displayed below, you will enable this feature.
+
+```
+{
+    "schedule": "daily", // daily|weekly|monthly
+    "ignoredFiles": [
+        "*.jpg",                   // ignore by extension
+        "image1.png",              // ignore by filename
+        "public/special_images/*", // ignore by folderpath
+    ],
+    "aggressiveCompression": "true" // true|false
+    "compressWiki": "true" // true|false
+}
+```

Docs/configuration.md

@@ -15,6 +15,7 @@ Here is an example .imgbotconfig setup that shows some of the options.
         "public/special_images/*", // ignore by folderpath
     ],
     "aggressiveCompression": "true" // true|false
+    "compressWiki": "true" // true|false
 }
 ```
 

README.md

@@ -19,7 +19,8 @@ This file should be placed in the root of the repository and set to your liking.
     	"image1.png",              // by filename
     	"public/special_images/*", // by folderpath
     ],
-    "aggressiveCompression": true // true|false
+    "aggressiveCompression": "true", // true|false
+    "compressWiki": "true" // true|false
 }
 ```
 
@@ -49,6 +50,14 @@ to [email protected]
 - Opt in to use lossy compression algorithms
 - The default behavior without this setting is lossless compression
 
+**compressWiki**
+
+- optional
+- Accepts: true|false
+- Opt in to also compress wiki repo
+    - Example: `https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git`
+- The default behavior is opt out
+
 Find out more: https://imgbot.net/docs
 
 ## Contributing

Web/src/docs/metadata.json

@@ -27,6 +27,10 @@
     "slug": "aggressive-compression",
     "title": "Aggressive compression"
   },
+  {
+    "slug": "compress-wiki",
+    "title": "Compress wiki"
+  },
   {
     "slug": "authorization",
     "title": "Authorization"