README.md in awesome_bot-1.18.0 vs README.md in awesome_bot-1.19.0
- old
+ new
@@ -16,22 +16,22 @@
## Usage
### Command Line
-```
+``` shell
Usage: awesome_bot [file or files]
awesome_bot [options]
-f, --files [files] Comma separated files to check
-a, --allow [errors] Status code errors to allow
--allow-dupe Duplicate URLs are allowed
--allow-ssl SSL errors are allowed
--allow-redirect Redirected URLs are allowed
--allow-timeout URLs that time out are allowed
--base-url [base url] Base URL to use for relative links
-d, --request-delay [seconds] Set request delay
- -t, --set-timeout [seconds] Set connection timeout
+ -t, --set-timeout [seconds] Set connection timeout (default: 30)
--skip-save-results Skip saving results
-w, --white-list [urls] Comma separated URLs to white list
```
- You can check multiple files (comma separated or `*` pattern, look below for details).
@@ -191,28 +191,13 @@
script:
# Link Checks
- docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --allow-dupe --allow-redirect --skip-save-results `find . -name "*.md"`
```
-### CircleCI
-
-If you prefer CircleCI, it'll work too. [Connect your repo](https://circleci.com/) and create a [`circle.yml` file](https://github.com/tmcw/awesome-geojson).
-
-```yml
-machine:
- ruby:
- version: 2.4.1
-test:
- pre:
- - gem install awesome_bot
- override:
- - awesome_bot README.md
-```
-
### More
-CircleCI, [Codeship](https://codeship.com/), and [Semaphore CI](https://semaphoreci.com/) support running tests without adding a file to the repo (a public configuration file can however help others contribute).
+[CircleCI](https://circleci.com), [Codeship](https://codeship.com/), and [Semaphore CI](https://semaphoreci.com/) support running tests without adding a file to the repo (a public configuration file can however help others contribute).
```
# Codeship
Setup
rvm use 2.4.1 --install
@@ -232,11 +217,11 @@
awesome_bot README.md
```
### Status Badge
-[](https://travis-ci.org/unixorn/awesome-zsh-plugins)
+[](https://travis-ci.org/unixorn/awesome-zsh-plugins)
To add the Travis CI build status badge above to your project, use the following code
```
[](https://travis-ci.org/<username>/<project>)
@@ -249,14 +234,14 @@
```
- awesome_bot README.md --white-list travis-ci
```
-You can also add a badge for other CI tools, check out [shields.io](http://shields.io/).
+You can also add a badge for other CI tools, check out [shields.io](https://shields.io/).
### Danger
-Integrate `awesome_bot` with [Danger](https://github.com/danger/danger) and have results reported back to the [pull request](https://github.com/vsouza/awesome-ios/pull/1001)).
+Integrate `awesome_bot` with [Danger](https://github.com/danger/danger) and have results reported back to the [pull request](https://github.com/vsouza/awesome-ios/pull/1001).
Here's the step in your **Dangerfile**: