Docs/add sample to readme (#25)

* update readme

* update

* update readme

* update readme

---------

Co-authored-by: Gang Tao <gang@timeplus.io>

Author: gangtao

Diff for: .gitignore

@@ -1,3 +1,5 @@
+.venv
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

Diff for: Makefile

@@ -4,4 +4,4 @@ build:
 	python3 -m build
 
 test:
-	pip install ./dist/proton-driver-0.2.4.tar.gz
+	pip install ./dist/timeplus-proton-driver-0.2.7.tar.gz

Diff for: README.rst

@@ -1 +1,72 @@
-This is forked from https://github.com/mymarilyn/clickhouse-driver. Necessary changes are made to support https://github.com/timeplus-io/proton with date types and namespaces changes.
+Timeplus Proton Python Driver
+================
+
+Introduction
+------------
+
+`Proton <https://github.com/timeplus-io/proton>`_ is a unified streaming and historical data processing engine in a single binary. The historical store is built based on `ClickHouse <https://github.com/ClickHouse/ClickHouse>`_.
+
+This project provides python driver to interact with Proton, the code is based on https://github.com/mymarilyn/clickhouse-driver.  
+
+
+Installation
+------------
+
+.. code-block:: shell
+
+   pip install proton-driver
+
+
+Quick Start
+------------
+
+1. Run proton with docker, ``docker run -d -p 8463:8463 --pull always --name proton ghcr.io/timeplus-io/proton:develop``
+2. Run following python code 
+
+.. code-block:: python
+
+   from proton_driver import connect
+   with connect("proton://default:@localhost:8463/default") as conn:
+     with conn.cursor() as cursor:
+       cursor.execute("select 1")
+       print(cursor.fetchone())
+
+above code should return ``(1,)`` , which shows that everything is working fine now.
+
+Streaming Query
+------------
+
+.. code-block:: python
+
+  from proton_driver import client
+
+  c = client.Client(host='127.0.0.1', port=8463)
+
+  # create a random stream if not exist
+  c.execute("CREATE RANDOM STREAM IF NOT EXISTS"
+            " devices("
+            " device string default 'device'||to_string(rand()%4), "
+            " temperature float default rand()%1000/10"
+            ")")
+  # query the stream and return in a iterator
+  rows = c.execute_iter(
+      "SELECT device, count(*), min(temperature), max(temperature) "
+      "FROM devices GROUP BY device",
+  )
+  for row in rows:
+      print(row)
+
+
+the output of the code will be something like following, as for streaming query is unbouded, you can add your flow control to terminate the loop.
+
+.. code-block:: shell
+
+  ('device0', 747, 0.0, 99.5999984741211)
+  ('device1', 723, 0.10000000149011612, 99.30000305175781)
+  ('device3', 768, 0.30000001192092896, 99.9000015258789)
+  ('device2', 762, 0.20000000298023224, 99.80000305175781)
+  ('device0', 1258, 0.0, 99.5999984741211)
+  ('device1', 1216, 0.10000000149011612, 99.69999694824219)
+  ('device3', 1276, 0.30000001192092896, 99.9000015258789)
+  ('device2', 1250, 0.20000000298023224, 99.80000305175781)
+