diff --git a/README.md b/README.md index 154bf9ba1..4028c21b2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Imgbot -Imgbot crawls all your image files in GitHub and submits pull requests after applying a lossless compression. +Imgbot crawls all your image files in GitHub and submits pull requests after applying a loss less compression. This will make the file size go down, but leave the dimensions and quality just as good. ![screenshot](https://imgbot.net/images/screen.png?cache=2) @@ -26,43 +26,43 @@ This file should be placed in the root of the repository and set to your liking. ``` The following are the currently supported parameters. -If there are any configuration settings you would like to see supported, +If there are any configuration settings you would like to see changed or supported, please feel free to open an issue here in the repo or shoot an email over to help@imgbot.net **schedule** -- optional +- Optional - Accepts: daily|weekly|monthly - Limits the PRs from Imgbot to once a day, once a week, or once a month respectively - The default behavior is to receive Imgbot PRs as images require optimization **ignoredFiles** -- optional +- Optional - Accepts the syntax for searchPattern on [Directory.EnumerateFiles()](https://docs.microsoft.com/en-us/dotnet/api/system.io.directory.enumeratefiles) - Limits the images optimized by Imgbot by essentially ignoring them -- When ignoring by filename no path is necessary, when ignoring by foldername full path from root is necessary +- When ignoring by file name no path is necessary, when ignoring by folder name full path from root is necessary **aggressiveCompression** -- optional +- Optional - Accepts: true|false - Opt in to use lossy compression algorithms -- The default behavior without this setting is lossless compression +- The default behaviour without this setting is loss less compression **compressWiki** -- optional +- 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 +- The default behaviour is opt out **minKBReduced** -- optional +- Optional - Accepts only numbers as input (e.g. `"minKBReduced": 500` for a 500 KB threshold) - Can be used to limit the frequency of PRs Imgbot will open over time - The default setting is 10