diff --git a/README.md b/README.md index 877f29b..40385a0 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ It has two commands ([check](#check) and [compare](#compare)) and a few option s The `data` folder contains some channel lists and output files for testing. + ## check `./sani.py check data/test_chans_good.txt` @@ -16,6 +17,8 @@ The `data` folder contains some channel lists and output files for testing. +Successful connections will be marked in green, failed connection in red, and alarm states will be printed in yellow. + ## compare @@ -27,4 +30,7 @@ The `data` folder contains some channel lists and output files for testing. -(Note here that `.csv` is automatically appended if missing.) +Entries that are identical in both files will not be shown. Differences will be printed as `LEFT | RIGHT`. + +(Note that `.csv` is automatically appended to filenames if missing.) +