Merge "Document the JSON schema a little."

10 years ago · 4ed170cb11
parent 8618a393f5 a2b96dffc2
commit 4ed170cb11
1 changed files with 12 additions and 0 deletions
--- 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.