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)