From 6da14fad3596c1dbf0c0b90296efebf233e7d8ee Mon Sep 17 00:00:00 2001
From: Prithvi Prabhu <prithvi@h2o.ai>
Date: Wed, 17 Jun 2020 10:39:26 -0700
Subject: [PATCH] Change readme.md to rst for pypi h2oai/q#678

---
 py/README.md  |  6 -----
 py/README.rst | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+), 6 deletions(-)
 delete mode 100644 py/README.md
 create mode 100644 py/README.rst

diff --git a/py/README.md b/py/README.md
deleted file mode 100644
index 139c69cb82..0000000000
--- a/py/README.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# telesync
-
-Python driver for H2O Q / Telesync realtime apps
-
-
-
diff --git a/py/README.rst b/py/README.rst
new file mode 100644
index 0000000000..d8ef8b6a9c
--- /dev/null
+++ b/py/README.rst
@@ -0,0 +1,69 @@
+Telesync
+========
+
+Telesync is a lightweight library for programming interactive web applications
+entirely in Python (no HTML/Javascript/CSS) required.
+
+It is designed to make it fast, fun and easy to build low-latency, realtime,
+collaborative, web-based applications. It ships batteries-included with
+a suite of form and data visualization components for rapidly prototyping
+analytical and decision-support applications.
+
+Telesync's components work in conjunction with the Telesync relay server
+that facilitates realtime state synchronization between Python and web browsers.
+
+The Telesync relay server is built into H2O.ai Q for enterprise-grade hosting.
+
+
+Installing
+----------
+
+Install and update using `pip`_:
+
+.. code-block:: text
+
+    pip install -U telesync
+
+
+Hello world
+----------------
+
+.. code-block:: python
+
+    from telesync import Site, ui
+
+    # Connect to the Telesync server.
+    site = Site()
+
+    # Get the web page at route '/demo'.
+    # If you're running this example on your local machine,
+    # this page will refer to http://localhost:55555/demo.
+    page = site['/demo']
+
+    # Add some content to the page.
+    page['example'] = ui.markdown_card(
+      box='1 1 2 2',
+      title='Hello World!',
+      content='And now for something completely different.',
+    )
+
+    # Finally, sync the page to update the web browser.
+    page.sync()
+
+
+.. code-block:: text
+
+    $ python hello.py
+
+
+Links
+-----
+
+* Website: https://www.h2o.ai/h2o-q/
+* Releases: https://pypi.org/project/telesync/
+* Code: https://github.com/h2oai/telesync
+* Issue tracker: https://github.com/h2oai/telesync/issues
+
+
+.. _pip: https://pip.pypa.io/en/stable/quickstart/
+