Update README.md

2015-04-25 00:09:24 -04:00 · 2015-04-25 00:09:24 -04:00 · 6bd34fb0a2
commit 6bd34fb0a2
parent 00acacb129
1 changed files with 18 additions and 0 deletions
--- 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)