README.md in html-proofer-1.3.3 vs README.md in html-proofer-1.4.0

- old
+ new

@@ -61,11 +61,11 @@ You'll get a new program called `htmlproof` with this gem. Terrific! Use it like you'd expect to: ``` bash -htmlproof run ./out --swap wow:cow,mow:doh --ext .html.erb --ignore www.github.com +htmlproof ./out --swap wow:cow,mow:doh --ext .html.erb --ignore www.github.com ``` Note: since `swap` is a bit special, you'll pass in a pair of `RegEx:String` values. `htmlproof` will figure out what you mean. @@ -137,16 +137,30 @@ | `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` | | `href_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. | `{}` | | `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` | | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` | +### Configuring Typhoeus + You can also pass in any of Typhoeus' options for the external link check. For example: ``` ruby HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost => 2 }) ``` This sets `HTML::Proofer`'s extensions to use _.htm_, and gives Typhoeus a configuration for it to be verbose, and use specific SSL settings. Check [the Typhoeus documentation](https://github.com/typhoeus/typhoeus#other-curl-options) for more information on what options it can receive. + +### Configuring Parallel + +[Parallel](https://github.com/grosser/parallel) is being used to speed things up a bit. You can pass in any of its options with the options "namespace" `:parallel`. For example: + +``` ruby +HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost => 2, :parallel => { :in_processes => 3} }) +``` + +`:in_processes => 3` will be passed into Parallel as a configuration option. + +### Array of links Instead of a directory as the first argument, you can also pass in an array of links: ``` ruby HTML::Proofer.new(["http://github.com", "http://jekyllrb.com"])