summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 277b642..819811f 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,8 @@
-pygerrit is a python library that can be used to process the data from events
-generated by the Gerrit code review system.
+Pygerrit - Client library for interacting with Gerrit Code Review
+=================================================================
+
+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
@@ -11,7 +14,7 @@ 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
+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.