Add more detailed examples of SSH interface usage in the README

Refs #9

Change-Id: I335782f5b3126ee00ba8fbe43372c02e7506eb35

1 files changed, 35 insertions, 2 deletions

diff --git a/README.rst b/README.rst
index f8eae5a..d825bc4 100644
--- a/README.rst
+++ b/README.rst
@@ -31,6 +31,24 @@ file:
       Port 29418
       User username
 
+SSH Interface
+-------------
+
+The SSH interface can be used to run commands on the Gerrit server.
+
+.. code-block:: pycon
+
+    >>> from pygerrit.ssh import GerritSSHClient
+    >>> client = GerritSSHClient("review")
+    >>> result = client.run_gerrit_command("version")
+    >>> result
+    <GerritSSHCommandResult [version]>
+    >>> result.stdout
+    <paramiko.ChannelFile from <paramiko.Channel 2 (closed) -> <paramiko.Transport at 0xd2387d90L (cipher aes128-cbc, 128 bits) (active; 0 open channel(s))>>>
+    >>> result.stdout.read()
+    'gerrit version 2.6.1\n'
+    >>>
+
 Event Stream
 ------------
 
@@ -44,8 +62,23 @@ 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.
 
-Refer to the `example`_ script for a brief example of how the interface
-works.
+.. code-block:: pycon
+
+    >>> from pygerrit.client import GerritClient
+    >>> client = GerritClient("review")
+    >>> client.gerrit_version()
+    '2.6.1'
+    >>> client.start_event_stream()
+    >>> client.get_event()
+    <CommentAddedEvent>: <Change 12345, platform/packages/apps/Example, master> <Patchset 1, 5c4b2f76297f04fbab77eb8c3462e087bc4b6f90> <Account Bob Example (bob.example@example.com)>
+    >>> client.get_event()
+    <CommentAddedEvent>: <Change 67890, platform/frameworks/example, master> <Patchset 2, c7d4f9956c80b1df66a66d66dea3960e71de4910> <Account John Example (john.example@example.com)>
+    >>> client.stop_event_stream()
+    >>>
+
+
+Refer to the `example`_ script for a more detailed example of how the SSH
+event stream interface works.
 
 
 Copyright and License