From a2b96dffc2923c39a3af7b630e0c9dd00187c44d Mon Sep 17 00:00:00 2001
From: Robert Collins <rbtcollins@hp.com>
Date: Wed, 27 Nov 2013 03:14:55 +0000
Subject: [PATCH] Document the JSON schema a little.

Change-Id: I804a6d347abf297b3ea84be3dbdf2748e18f4aa5
---
 README.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.rst b/README.rst
index 0a3473b..21b63c6 100644
--- a/README.rst
+++ b/README.rst
@@ -19,3 +19,15 @@ Usage
 pip install reviewstats
 
 Run the scripts.
+
+Project definitions
+-------------------
+
+Each project has a JSON file describing what reviews, bugs and so on will count
+towards that projects statistics. The JSON file should have a single top level
+object containing the following keys:
+
+* name: The project name.
+* subprojects: A list of Gerrit projects to include
+* core-team: A list of Gerrit usernames to consider as core reviewers across
+  subprojects.