From 660cd26f31b3979149950c1fdea995b85a774c1c Mon Sep 17 00:00:00 2001
From: Gav Wood <i@gavwood.com>
Date: Fri, 21 Feb 2014 18:35:51 +0000
Subject: [PATCH] More docs.
---
README.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.md b/README.md
index 6ceeb19de..0f7dbe5a6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
tests
=====
+
+Common tests for all clients to test against.
+
+All files should be of the form:
+
+```
+{
+ "test1name":
+ {
+ "test1property1": ...,
+ "test1property2": ...,
+ ...
+ },
+ "test2name":
+ {
+ "test2property1": ...,
+ "test2property2": ...,
+ ...
+ }
+}
+```
+
+Arrays are allowed, but don't use them for sets of properties - only use them for data that is clearly a continuous contiguous sequence of values.
+
--
GitLab