From 40346a646121aebbd57b7f4c3c278ec8d671ad4d Mon Sep 17 00:00:00 2001
From: Sven Augustin <sven.augustin@psi.ch>
Date: Tue, 22 Sep 2020 13:20:43 +0200
Subject: [PATCH] added something to read

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index e30ff14..60bb55b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
 # sanipy
 
+sanipy is a command-line tool for epics connection testing.
+
+It has two commands ([check](check) and [compare](compare)) and a few option switches (check `sani.py -h` and `sani.py COMMAND -h`).
+
+The `data` folder contains some channel lists and output files for testing.
+
+## check
+
+`./sani.py check data/test_chans_good.txt`
+<img src="docs/check_good.png" width="491">
+
+`./sani.py check data/test_chans_bad.txt`
+<img src="docs/check_bad.png" width="491">
+
+
+## compare
+
+`./sani.py compare data/test1.csv data/test4 -v`
+<img src="docs/compare_good.png" width="568">
+
+`./sani.py compare data/test1.csv data/test3`
+<img src="docs/compare_bad.png" width="658">
+
+(Note here that `.csv` is automatically appended if missing.)