Update README to reflect varied usecases and available CLI options

subbuss · subbuss · commit fa0ea0e8bfc5 · 2015-09-14T13:08:47.000-05:00
diff --git a/README.md b/README.md
@@ -23,6 +23,20 @@ OR this script
 
     node bin/gen.visual_diff.js --help
 
+## Examples
+
+``` bash
+# Compare rendering of two existing HTML files
+$ node gen.visual_diff.js --outdir /tmp/ --url1 file://`pwd`/enwiki/Hampi.php.html --url2 file://`pwd`/enwiki/Hampi.parsoid.html
+
+# Fetch PHP parser and Parsoid HTML output from their servers and compare them (read config from a config file)
+$ node gen.visual_diff.js --wiki itwiki --title Luna --config parsoid.diffsettings.js
+
+# Fetch PHP parser and Parsoid HTML output from their servers and compare them (config on commandline), and also dump the HTML
+# after suitably postprocessing them
+$ node gen.visual_diff.js --wiki enwiki --title Hampi --html1PP ../lib/php_parser.postprocess.js --html2PP ../lib/parsoid.postprocess.js --dumpHTML1 --dumpHTML2
+```
+
 ## Testreduce client
 
 testreduce/ has client scripts and example config for mass testing
