diff --git a/README.md b/README.md index d62ddb1..45d9bbd 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ # ETF Autotest Parser -Python program for parsing ETF autotest scripts (written in JSON). It produces a `.txt` output file where with all of the unit tests. +## About + +Python program for parsing ETF autotest scripts. It produces a `.txt` output file with all of the unit tests and expected outputs. ## Usage +To use the program simply run the following command: + ```bash python etf-parse.py ``` + +You should replace `` with the name of the file containing unit tests. By default this argument will be `autotest2`, so simply running `python etf-parse.py` will look for `autotest2` in the current directory.