summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@sonymobile.com>2013-01-18 18:53:46 +0900
committerDavid Pursehouse <david.pursehouse@sonymobile.com>2013-01-18 18:55:12 +0900
commit9768a367035deef3eda1b8ed13b666662fc8ca8f (patch)
treea26701ff8ecb44cb45e8d142373b5bba5966e689 /README
parentf66a93273ccc3997b2768e93d815592ee4f39fcd (diff)
downloadpygerrit-9768a367035deef3eda1b8ed13b666662fc8ca8f.tar.gz
Rename the readme and license files
We are not using Markdown, so there is no need for them to be .md files. Also, when making the Python distribution it expects the file to be named README and emits a warning when it does not exist. Change-Id: Ie845787c057e6cc0f9bda426a4da6d2bb5cef75e
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.