From 941967c98e12e1b8e3e49ccadad6e4c5b9c01d36 Mon Sep 17 00:00:00 2001
From: doronporat <dporat@yotpo.com>
Date: Thu, 19 Dec 2019 21:25:56 +0200
Subject: [PATCH] feat(readme): add documentation on new metorikkuTester
 feature for csv output mocks

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

diff --git a/README.md b/README.md
index 82c7267f9..ce2a00ba9 100644
--- a/README.md
+++ b/README.md
@@ -136,6 +136,29 @@ And the corresponding `mocks/table_1.jsonl`:
 { "id": 1, "name": "test3" }
 ```
 
+Note that it is also possible to use csv mocks for the Expected output. In this case use the `testsFiles` option instead of `tests` like this - 
+
+```yaml
+metric: "/path/to/metric"
+mocks:
+- name: table_1
+  path: mocks/table_1.jsonl
+testsFiles:
+- name: expected
+  path: "/path/to/expected.csv"
+keys:
+  df2: 
+  - id
+  - name
+```
+
+while the csv file under "/path/to/expected.csv" will look like this -
+```csv
+id,name
+200,test
+300,test2
+```
+
 The Keys section allows the user to define the unique columns of every DataFrame's expected results - 
 every expected row result should have a unique combination for the values of the key columns. 
 This part is optional and can be used to define only part of the expected DataFrames -