More docs.

2026-02-28 05:56:45 +01:00 · 2014-02-21 18:35:51 +00:00
parent 6ad14c1a15
commit 660cd26f31
1 changed files with 24 additions and 0 deletions
--- 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.
+