README.md in html-proofer-0.7.1 vs README.md in html-proofer-0.7.2

- old
+ new

@@ -17,11 +17,11 @@ $ bundle Or install it yourself as: $ gem install html-proofer - + **NOTE:** When installation speed matters, set `NOKOGIRI_USE_SYSTEM_LIBRARIES` to `true` in your environment. This is useful for increasing the speed of your Continuous Integration builds. ## Usage ### Using in a script @@ -102,11 +102,11 @@ The `HTML::Proofer` constructor takes an optional hash of additional options: * `:ext`: the extension (including the `.`) of your HTML files (default: `.html`) * `:href_swap`: a hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. -* `:href_ignore`: an array of Strings or RegExps containing `href`s that are safe to ignore (`mailto` is always ignored) +* `:href_ignore`: an array of Strings or RegExps containing `href`s that are safe to ignore (certain URIs, like `mailto` and `tel`, are always ignored) * `:disable_external`: if `true`, does not run the external link checker, which can take a lot of time (default: `false`) * `:verbose`: if `true`, outputs extra information as the checking happens. Useful for debugging. (default: `false`) You can also pass in any of Typhoeus' options for the external link check. For example: @@ -151,6 +151,5 @@ end end end end ``` -