Merge pull request #104 from tapdata/docs/update-readme

Docs/update readme

README.md

@@ -1,5 +1,29 @@
+<div align="center">
+
+[![Release](https://img.shields.io/github/v/tag/tapdata/tapflow.svg?sort=semver)](https://github.com/tapdata/tapflow/releases)
 [![PyPI Downloads](https://static.pepy.tech/badge/tapflow)](https://pepy.tech/projects/tapflow)
 
+</div>
+
+## Table of Contents
+- [What is TapFlow](#what-is-tapflow)
+- [Why is a Programmatic Approach Needed ?](#why-is-a-programmatic-approach-needed-)
+- [TapFlow Usage Example](#tapflow-usage-example)
+  - [Installing TapFlow](#installing-tapflow)
+  - [Create Source and Target Database Connections](#create-source-and-target-database-connections)
+  - [Create a Simple Order Table Replication Task (Data Flow)](#create-a-simple-order-table-replication-task-data-flow)
+  - [Exclude Fields](#exclude-fields)
+  - [Field Rename](#field-rename)
+  - [Perform Complex Custom Processing with Python Script](#perform-complex-custom-processing-with-python-script)
+  - [Use Lookup to Enrich Customer Information in the Order Table](#use-lookup-to-enrich-customer-information-in-the-order-table)
+  - [Final Result In Monogdb](#final-result-in-monogdb)
+  - [Run Python Code using TapFlow command](#run-python-code-using-tapflow-command)
+- [Known Issue](#known-issue)
+- [TapFlow Roadmap](#tapflow-roadmap)
+- [About TapData Live Data Platform](#about-tapdata-live-data-platform)
+- [Common Use Cases of TapData](#common-use-cases-of-tapdata)
+- [Join Our Community](#join-our-community)
+
 ## What is TapFlow
 
 TapFlow is a newly launched programming API framework for the TapData Live Data Platform. It allows developers and data engineers to build data pipelines and models using a simple powerful programming language.

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='tapflow',
-    version='0.2.52',
+    version='0.2.53',
     packages=find_packages(),
     install_requires=required,
     include_package_data=True,
@@ -24,4 +24,10 @@
     python_requires='>=3.6',
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
+    url="https://tapdata.net/",
+    project_urls={
+        "Documentation": "https://docs.tapdata.net/tapflow/introduction",
+        "Source": "https://github.com/tapdata/tapflow",
+        "Tracker": "https://github.com/tapdata/tapdata/issues",
+    },
 )