aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGav Wood <i@gavwood.com>2014-02-22 02:35:51 +0800
committerGav Wood <i@gavwood.com>2014-02-22 02:35:51 +0800
commit660cd26f31b3979149950c1fdea995b85a774c1c (patch)
tree9cdea59840933911c0230de1a88eb98854e5cd3d
parent6ad14c1a157e707fd15c87816e8ad872f69790db (diff)
downloadgo-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.tar
go-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.tar.gz
go-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.tar.bz2
go-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.tar.lz
go-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.tar.xz
go-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.tar.zst
go-tangerine-660cd26f31b3979149950c1fdea995b85a774c1c.zip
More docs.
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
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.
+