Merge pull request #375 from VirenMohindra/patch-1

#374 for more clarity for CLI flags
gjtorikian · Feb 3, 2017 · 5059d5a · 5059d5a
2 parents a2f6c0a + 5009552
commit 5059d5a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -135,6 +135,11 @@ HTMLProofer.check_links(['http://github.com', 'http://jekyllrb.com'])
 
 This configures Proofer to just test those links to ensure they are valid. Note that for the command-line, you'll need to pass a special `--as-links` argument:
 
+**Note:** flags are different from the default ones provided above. The underscores are replaced with dashes.
+
+`allow_hash_href` will be `--allow-hash-href`
+
+
 ``` bash
 htmlproofer www.google.com,www.github.com --as-links
 ```