From 78116ced9a4e07de742be4fa78cf608e2f2240a7 Mon Sep 17 00:00:00 2001 From: jem Date: Fri, 11 Oct 2019 17:04:17 +0200 Subject: [PATCH] update doc --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca6406e..c9247f9 100644 --- a/README.md +++ b/README.md @@ -82,9 +82,20 @@ As you can see, input and expected can be used in your test code. You have to de You can use [aero](https://github.com/juxt/aero) in your test data declaration, e.g. ```clojure -{:to-be-refernced "ref-test" - :key1 #ref [:to-be-refernced] - :key2 #ref [:to-be-refernced]} +{:references {:to-be-refernced "ref-test"} + :input #ref [:references :to-be-refernced] + :expected #ref [:references :to-be-refernced]} +``` + +### Adding Meta +You can add some metadata to your data files, e.g. + +```clojure +{:input some-data + :expected some-data + :meta {:name "name of data" + :description "describe what testcase is represented by this piec of data" + :link "https://add-some-link-here"}} ``` ### Generated Output