From 8bf5576780b37a0a0cced52f4b6a324a59d755d3 Mon Sep 17 00:00:00 2001
From: baztian <bastian.dev@gmail.com>
Date: Mon, 23 Jan 2017 20:33:52 +0100
Subject: [PATCH] Add an example for db connection properties

---
 .travis.yml |  1 +
 README.rst  | 21 ++++++++++++++++-----
 2 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 44798ec..36e0a03 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -46,6 +46,7 @@ install:
 script:
   - if [ -z "$JYTHON" ]; then PY="coverage run --source jaydebeapi"; else PY="python" ;fi
   - $PY test/testsuite.py $TESTNAME
+  - $PY -m doctest README.rst
 
 after_success:
   - if [ -z "$JYTHON" ]; then coveralls ;fi
diff --git a/README.rst b/README.rst
index 408b489..02b7fc1 100644
--- a/README.rst
+++ b/README.rst
@@ -88,10 +88,10 @@ environment.
 Here is an example:
 
 >>> import jaydebeapi
->>> conn = jaydebeapi.connect('org.hsqldb.jdbcDriver',
-...                           'jdbc:hsqldb:mem:.',
-...                           ['SA', ''],
-...                           '/path/to/hsqldb.jar',)
+>>> conn = jaydebeapi.connect("org.hsqldb.jdbcDriver",
+...                           "jdbc:hsqldb:mem:.",
+...                           ["SA", ""],
+...                           "/path/to/hsqldb.jar",)
 >>> curs = conn.cursor()
 >>> curs.execute('create table CUSTOMER'
 ...                '("CUST_ID" INTEGER not null,'
@@ -102,12 +102,23 @@ Here is an example:
 >>> curs.execute("select * from CUSTOMER")
 >>> curs.fetchall()
 [(1, u'John')]
+>>> curs.close()
+>>> conn.close()
+
+An alternative way to establish connection using connection
+properties:
+>>> conn = jaydebeapi.connect("org.hsqldb.jdbcDriver",
+...                           "jdbc:hsqldb:mem:.",
+...                           {'user': "SA", 'password': "",
+...                            'other_property': "foobar"},
+...                           "/path/to/hsqldb.jar",)
+
 
 If you're having trouble getting this work check if your ``JAVA_HOME``
 environmentvariable is set correctly. For example I have to set it on
 my Ubuntu machine like this ::
 
-    $ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python
+    $ JAVA_HOME=/usr/lib/jvm/java-8-openjdk python
 
 Supported databases
 ===================