Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README.md with punctuation #787

Merged
merged 2 commits into from
Nov 20, 2020
Merged

Updated README.md with punctuation #787

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc1f694
Update README.md
baishakhi9931 Nov 5, 2020
ac7b886
Update README.md
baishakhi9931 Nov 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,34 +26,34 @@ 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 filename no path is necessary, when ignoring by folder name full path from root is necessary
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably change filename to file name also.


**aggressiveCompression**

- optional
- Optional
- Accepts: true|false
- Opt in to use lossy compression algorithms
- The default behavior without this setting is lossless compression

**compressWiki**

- optional
- Optional
- Accepts: true|false
- Opt in to also compress wiki repo
- Example: `https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git`
Expand All @@ -62,7 +62,7 @@ to help@imgbot.net

**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
Expand Down