Initial commit of Crowd Gerrit Group Sync
Change-Id: I9614ed63baf9ac0f4166ae730a017854522922e7
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..8630157
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,19 @@
+Crowd-Gerrit Group Sync (cggs)
+------------------------------
+
+This script synchronizes a Crowd group to a Gerrit group.
+
+The Crowd Group is the source of truth.
+
+Matching between these is done based on the email address listed in Crowd.
+
+In the future, checking that the ``external.id`` in Gerrit is the same as the
+Crowd ``name`` parameter per the CrowdID login may be implmented, but the API
+permissions required to make this work in Gerrit aren't supported in the Gerrit
+2.14 we're currently using.
+
+Setup
+'''''
+
+Copy the ``settings_example.json`` to ``settings.json``, and add suitable
+credentials.