diff options
| author | David Pursehouse <david.pursehouse@sonymobile.com> | 2013-08-07 17:09:11 +0900 |
|---|---|---|
| committer | David Pursehouse <david.pursehouse@sonymobile.com> | 2013-08-07 17:19:58 +0900 |
| commit | e2ac5bde478dc2a7dbc58d6a2f716fa87623ec3a (patch) | |
| tree | 9439ffed0bb744844a2e2bceb104b4f32693249e | |
| parent | 4b0f5bdc05ed61d23cf53c62a9c05d78b7b97625 (diff) | |
| download | pygerrit-e2ac5bde478dc2a7dbc58d6a2f716fa87623ec3a.tar.gz | |
Improve formatting in the README file
- Add a proper title
- Correct capitalisation
- Add missing punctuation
Change-Id: I1edc431c389fedb8750f70f85a4b3eb11385a54e
| -rw-r--r-- | README.rst | 9 |
1 files changed, 6 insertions, 3 deletions
@@ -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. |