summaryrefslogtreecommitdiffstats
path: root/protocols
diff options
context:
space:
mode:
authorHåkon Hallingstad <hakon@yahoo-inc.com>2017-01-19 14:59:24 +0100
committerHåkon Hallingstad <hakon@yahoo-inc.com>2017-01-19 14:59:24 +0100
commitb5f5b32c3aa38dc5288b464ee87bfc07a7257b3d (patch)
tree3a36f3ba9a32e50ebbb3278944587f18931bba42 /protocols
parent1801df6d4bb2a7a082ae0da445185b4038e53095 (diff)
Add README.md for protocols module
Diffstat (limited to 'protocols')
-rw-r--r--protocols/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/protocols/README.md b/protocols/README.md
new file mode 100644
index 00000000000..b379195578c
--- /dev/null
+++ b/protocols/README.md
@@ -0,0 +1,6 @@
+# Cross-module protocol definitions
+
+This module can be used as a place to put cross-module definitions of APIs
+(e.g. JSON). For instance, put golden JSON files that are supposed to be
+generated by the distributor (in some C++ tests), and read by Cluster
+Controller (in some Java tests). This module is supposed to be light-weight.