summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..277b642
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+pygerrit is a python library that can be used to process the data from events
+generated by the Gerrit code review system.
+
+Gerrit offers a "stream-events" command that is run over ssh, and returns back
+a stream of events (new change uploaded, change merged, comment added, etc) as
+JSON text.
+
+This library handles the parsing of the JSON text from the event stream,
+encapsulating the data in event objects (Python classes), and allowing the
+client to fetch them from a queue. It also allows users to easily add handling
+of custom event types, for example if they are running a customised Gerrit
+installation with non-standard events.
+
+For examples of usage, please refer to example.py
+
+Copyright 2011 Sony Ericsson Mobile Communications. All rights reserved.
+Copyright 2012 Sony Mobile Communications. All rights reserved.
+
+Licensed under The MIT License. Please refer to the LICENSE file for full
+license details.