summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Goodman <wagoodman@users.noreply.github.com>2015-04-25 00:09:24 -0400
committerAlex Goodman <wagoodman@users.noreply.github.com>2015-04-25 00:09:24 -0400
commit6bd34fb0a2ce9b3f881b53d8ccef76a2c9fa7564 (patch)
tree333a32e090aee43830c059f7316f2c0a1d67611d /README.md
parent00acacb129c7458a4090f22739c2ede00959b0de (diff)
downloadwsdiff-6bd34fb0a2ce9b3f881b53d8ccef76a2c9fa7564.tar.gz
wsdiff-6bd34fb0a2ce9b3f881b53d8ccef76a2c9fa7564.tar.bz2
wsdiff-6bd34fb0a2ce9b3f881b53d8ccef76a2c9fa7564.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index deb848c..732669a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
# diff2HtmlCompare
+
+A python script that takes two files and compares the differences between them (side-by-side) in an HTML format.
+
+###Usage
+```
+diff2HtmlCompare.py [-h] [-v] file1 file2
+
+positional arguments:
+ file1 source file to compare ("before" file).
+ file2 source file to compare ("after" file).
+
+optional arguments:
+ -h, --help show this help message and exit
+ -v show verbose output.
+```
+### Example Output
+
+![ScreenShot](/screenshots/latest.png)