Merge pull request #233 from p1ng-request/patch-8

Update README.md

README.md

@@ -1,3 +1,4 @@
+<img src="https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/lang-icons/icon128px.png" width="22px" /> English | [简体中文](./README-zh.md)
 <div align="center">
   <br>
   <p align="center">
@@ -52,19 +53,37 @@ Welcome to the [Kanaries RATH](https://kanaries.net/). We are so excited to have
 
 **RATH** is beyond an open-source alternative to Data Analysis and Visualization tools such as Tableau. It automates your Explotoary Data Analysis workflow with an Augmented Analytic engine by discovering patterns, insights, causals and presents those insights with powerful auto-generated multi-dimensional data visualization.
 
-**RATH** is an ongoing project, actively being developed and maintained by a group of data scientists, developers and community ethuastists. We are a group of people who are passionate about creating the next generation of data analytic tool.
+<img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github_readme.gif" alt="GitHub ReadMe Demo"/>
+
+## Get started
+
+To get started with RATH, you can:
+- 🚀 [Try RATH in a browser](https://rath.kanaries.net)
+- 📖 [Read RATH Docs](https://docs.kanaries.net)
+- ⭐️ Give us a star on GitHub
+
+
+**RATH** is an ongoing project, actively being developed and maintained by a group of data scientists, developers and community enthusiasts. We are a group of people who are passionate about creating the next generation of data analytic tools.
 
 💪Join us, let's build it up!💪
 
-[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=Kanaries&repo=Rath&theme=radical)](https://github.com/Kanaries/Rath)
+<a href="https://join.slack.com/t/kanaries/shared_invite/zt-1k60sgaxu-aGcuS7CwGeJUccE61iGopg"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/slack.png" alt="Join our Slack community" width="200"/></a>
+<a href="https://discord.gg/Z4ngFWXz2U"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/discord.png" alt="Join our Discord community" width="200"/> </a>
+
 
-![Alt](https://repobeats.axiom.co/api/embed/0aa0df006ea6857c02565043d39c2b0da5380f93.svg "Repobeats analytics image")
 
-> Visit our [official website](https://kanaries.net) for more information about the RATH proejct.
+> Please consider sharing your experience or thoughts about [Kanaries RATH](https://kanaries.net) with the border Open Source community. It really does help!
+
+[![GitHub Repo stars](https://img.shields.io/badge/share%20on-reddit-red?style=flat-square&logo=reddit)](https://reddit.com/submit?url=https://github.com/Kanaries/Rath&title=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science)
+[![GitHub Repo stars](https://img.shields.io/badge/share%20on-hacker%20news-orange?style=flat-square&logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/Kanaries/Rath)
+[![GitHub Repo stars](https://img.shields.io/badge/share%20on-twitter-03A9F4?style=flat-square&logo=twitter)](https://twitter.com/share?url=https://github.com/Kanaries/Rath&text=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science)
+[![GitHub Repo stars](https://img.shields.io/badge/share%20on-facebook-1976D2?style=flat-square&logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/Kanaries/Rath)
+[![GitHub Repo stars](https://img.shields.io/badge/share%20on-linkedin-3949AB?style=flat-square&logo=linkedin)](https://www.linkedin.com/shareArticle?url=https://github.com/Kanaries/Rath&title=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science)
+
 
 ## Table of contents
 
-| [Why use RATH?](#why-use-rath) | [Getting started](#get-started) | [Try RATH now](#try-rath-now) | [Feature highlights](#feature-highlights) | [Walkthroughs](#walkthroughs) | [Developer Documentation](#developer-documentation) | [Community](#community) | [Contributing](#contributing) | [License (AGPL)](#license-agpl) |
+| [Why use RATH?](#why-use-rath) | [Try RATH](#try-rath) | [Feature highlights](#feature-highlights) | [Walkthroughs](#walkthroughs) | [Developer Documentation](#developer-documentation) | [Project Status](#project-status) | [Community](#community) | [Contributions](#contributions) | [License (AGPL)](#license-agpl) |
 
 ## Why use RATH?
 
@@ -74,78 +93,91 @@ Welcome to the [Kanaries RATH](https://kanaries.net/). We are so excited to have
 - Flexible copilot to assist your data exploration journey.
 - Paint your data to explore your datasets directly with Data Painter.
 - Causal discovery and explainer module to help you understand complex data patterns.
-- Open APIs and SDK for embeding requirements.
+- Open APIs and SDK for embedding requirements.
 
-## Get started
+## Try RATH
 
-### Try RATH now
+You can either:
+- Run RATH in a browser. [RATH Cloud](https://rath.kanaries.net/)
+- Download the [desktop version](https://kanaries.net/#/products) for Windows/Mac.
+- Run your own RATH instance. Steps:
+Clone the Rath repository:
+```bash
+git clone https://github.com/Kanaries/Rath.git && cd Rath
+```
+Setup your Yarn workspace:
+```bash
+yarn install
+```
+Boot up RATH:
+```bash
+yarn workspace rath-client start
+```
 
-+ [RATH Cloud](https://rath.kanaries.net/)
-+ [Download desktop version](https://kanaries.net/#/products)
+## Feature highlights
+- 👓 [Data profiling](https://docs.kanaries.net/data-source): overview your data source with one click. You can upload, sample, define dimensions and measures, perform data cleaning and more complicated computing on your data source. 
 
-### Feature highlights
-- 👓 [Data profiling](https://kanaries.net/docs/data-source): overview your data source with one click. You can upload, sample, define dimensions and measures, perform data cleaning and more complicated computing upon your data source. 
+- 🤖 [Mega-auto exploration](https://docs.kanaries.net/auto-explore): a fully-automated way to explore your data set and visualize your data with one click. Leave everything to RATH, simply pick the associate view that inspires you the most.
 
-- 🤖 [Mega-auto exploration](https://kanaries.net/docs/auto-explore): a fully-automated way to explore your data set and visualize your data with one click. Leave everything to RATH, simply pick the associate view that inspires you the most.
+- 🛠 [Semi-auto exploration](https://docs.kanaries.net/semi-auto-explore): The middle ground between a fully automated Data Exploration and Tableau-like manual exploration. RATH will work as your copilot, learn your interests and uses AI to generate relevant recommendations for you.
 
-- 🛠 [Semi-auto exploration](https://kanaries.net/docs/semi-auto-explore): The middle ground between a fully automated Data Exploration and Tableau-like manual exploration. RATH will work as your copilot, learn your interests and uses AI to generate relevant recommendations for you.
+- 🎨 [Data painter](https://docs.kanaries.net/data-painter): An interactive, instinctive yet powerful tool for exploratory data analysis by directly coloring your data, with further analytical features.
 
-- 🎨 [Data painter](https://kanaries.net/docs/data-painter): An interactive, instinctive yet powerful tool for exploratory data analysis by directly coloring your data, with further analytical features.
+- :bar_chart: Dashboard: build a beautiful interactive data dashboard.
 
-- :bar_chart: Dashboard: build beautiful interactive data dashboard.
+- :construction: Causal Analysis: Provide causal discovery and explanations for complex relation analysis.
 
-- :construction: Causal Analysis: Provide causal discovery and explainations for complex relation analysis.
+- 🎓 Wanna learn more about RATH? Visit our [Free online Courses](https://docs.kanaries.net/blog/tags/course): Access learning materials, detailed instructions and skill tests for **FREE**!
 
-- 🎓 Wanna learn more about RATH? Visit our [Free online Courses](https://kanaries.net/docs/rath-academy): Access learning materials, detailed instructions and skill tests for **FREE**!
+## Walkthroughs
+### Import data
+**View statistics from your data source:**
 
-## Share with the community
+![View statistics from your data source](https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/study-biking-sharing-data-with-rath.webp)
 
-Please consider sharing your experience or thoughts about [kanaries rath](https://kanaries.net) and the value it provides. It really does help!
+**Try different data views:**
+![View your dataset](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/datasource-02.png)
 
-[![GitHub Repo stars](https://img.shields.io/badge/share%20on-reddit-red?style=flat-square&logo=reddit)](https://reddit.com/submit?url=https://github.com/Kanaries/Rath&title=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science)
-[![GitHub Repo stars](https://img.shields.io/badge/share%20on-hacker%20news-orange?style=flat-square&logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/Kanaries/Rath)
-[![GitHub Repo stars](https://img.shields.io/badge/share%20on-twitter-03A9F4?style=flat-square&logo=twitter)](https://twitter.com/share?url=https://github.com/Kanaries/Rath&text=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science)
-[![GitHub Repo stars](https://img.shields.io/badge/share%20on-facebook-1976D2?style=flat-square&logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/Kanaries/Rath)
-[![GitHub Repo stars](https://img.shields.io/badge/share%20on-linkedin-3949AB?style=flat-square&logo=linkedin)](https://www.linkedin.com/shareArticle?url=https://github.com/Kanaries/Rath&title=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science)
+### Conduct Automated Data Exploration
 
-## Walkthroughs
-### View statistics from your data source
-![View statistics from your data source](https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/study-biking-sharing-data-with-rath.webp
-)
-### Configure your dataset
-![Configure your dataset](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/datasource-02.png)
+**One-click data analysis with Mega-auto Exploration:**
 
-### One-click data analysis with Mega-auto Exploration
 ![One-click data analysis with Mega-auto Exploration](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/rath-mega-auto-01.png)
 
-### Generate more associate visualizations in Mega-auto Exploration
+**Generate more associate visualizations in Mega-auto Exploration:**
+
 ![Generate more associate visualizations in Mega-auto Exploration](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/rath-asso-01.png)
 
-### Use RATH as the Data Analysis copilot in Semi-auto Exploration
+### Use RATH as the Data Analysis Copilot
+
+**Provide RATH with some input in Semi-auto Exploration:**
+
 ![Use RATH as the Data Analysis copilot in Semi-auto Exploration](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/rath-semi-02.png)
 
-### RATH automatically learns your interest and generate recommendations
+**RATH automatically learns your interests and generates recommendations:**
+
 ![Use RATH as the Data Analysis copilot in Semi-auto Exploration](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/rath-semi-01.png)
 
-### Manually explore your data with a Tableau-like module
+### Manual data exploration
+
+**Manually explore your data with a Tableau-like module:**
 ![Use RATH as the Data Analysis copilot in Semi-auto Exploration](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/rath-gw-01.png)
 
 ![Use RATH as the Data Analysis copilot in Semi-auto Exploration](https://ch-resources.oss-cn-shanghai.aliyuncs.com/images/rath/1.0.0/rath-gw-02.png)
 
-Manual Exploration is an independent embedding module. You can use it independently in your apps. See more details in `packages/graphic-walker/README.md`
-
-```bash
-yarn add @kanaries/graphic-walker
-# or
-
-npm i --save @kanaries/graphic-walker
-```
+> Manual Exploration is an independent embedding module. You can use it independently in your apps. For more details, refer to the README.md in in `packages/graphic-walker/README.md`.
+>
+> Install Graphic Walker
+> ```bash
+> yarn add @kanaries/graphic-walker
+> # or
+>
+> npm i --save @kanaries/graphic-walker
+> ```
 
 ## Supported Databases
 
-RATH can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](https://superset.apache.org/docs/databases/installing-database-drivers/)) that has a Python DB-API driver and a SQLAlchemy dialect.
-
-Here are some of the major database solutions that are supported:
+RATH supports a wide range of data sources. Here are some of the major database solutions that you can connect to RATH:
 
 <p align="center">
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/athena.png" alt="Amazon Athena" border="0" width="200" height="80"/>
@@ -154,32 +186,37 @@ Here are some of the major database solutions that are supported:
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/doris.png" alt="Apache Doris" border="0" width="200" height="80"/>
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/clickhouse.png" alt="Clickhouse" border="0" width="200" height="80"/>
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/hive.png" alt="Apache Hive" border="0" width="200" height="80"/>
-  <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/mysql.svg" alt="MySQL" border="0" width="200" height="80"/>
+  <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/mysql.png" alt="MySQL" border="0" width="200" height="80"/>
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/postgresql.png" alt="Postgre SQL" border="0" width="200" height="80"/>
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/impala.png" alt="Apache Impala" border="0" width="200" height="80"/>
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/kylin.png" alt="Apache Kylin" border="0" width="200" height="80"/>
-  <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/oracle.svg" alt="Oracle" border="0" width="200" height="80"/>
+  <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/oracle.png" alt="Oracle" border="0" width="200" height="80"/>
   <img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/airtable.png" alt="AirTable" border="0" width="200" height="80"/>
 </p>
 
-If you want to add support for more database types or data engines, feel free to [contact us](https://kanaries.net/docs#contact-us)
+If you want to add support for more database types or data engines, feel free to [Contact us](https://docs.kanaries.net/join#-need-help)
 
 ## Developer Documentation
 
-We encourage you to check out our [RATH Docs](https://kanaries.net/docs) for references and guidance. RATH Docs are scripted and maintained by technical writers and editors who collectively follow a standardized [style guide](https://kanaries/docs/documentation-style-guide) to produce clear and consistent documentation.
+We encourage you to check out our [RATH Docs](https://docs.kanaries.net) for references and guidance. RATH Docs are scripted and maintained by technical writers and editors who collectively follow a standardized [style guide](https://docs.kanaries.net/documentation-style-guide) to produce clear and consistent documentation.
+
+## Project Status
+
+![Alt](https://repobeats.axiom.co/api/embed/0aa0df006ea6857c02565043d39c2b0da5380f93.svg "Repobeats analytics image")
 
 ## Community
 
-[Kanaries community](https://kanaries.net/community) is a place to have open discussions on features, voice your ideas, or get help with general questions. Get onboard with us through the following channels:
+[Kanaries community](https://docs.kanaries.net/community) is a place to have open discussions on features, voice your ideas, or get help with general questions. Get onboard with us through the following channels:
 
-Our developer community is the backbone of the ongoing RATH project. We sincerely welcome you to [join our community](join), participate in the conversation and stay connected with us for the latest updates. Feel free to [contribute to the RATH project](contribution-guide), submit any issues on our GitHub page, or split your grand new ideas in our chats.
+Our developer community is the backbone of the ongoing RATH project. We sincerely welcome you to [join our community](join), participate in the conversation and stay connected with us for the latest updates.
+- [Join our Slack](https://join.slack.com/t/kanaries/shared_invite/zt-1k60sgaxu-aGcuS7CwGeJUccE61iGopg)
+- [Join our Discord](https://discord.gg/Z4ngFWXz2U)
 
-<a href="https://join.slack.com/t/kanaries/shared_invite/zt-1k60sgaxu-aGcuS7CwGeJUccE61iGopg"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/slack.png" alt="Join our Slack community" width="200"/></a>
-<a href="https://discord.gg/Z4ngFWXz2U"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/discord.png" alt="Join our Discord community" width="200"/> </a>
+Feel free to [contribute to the RATH project](contribution-guide), submit any issues on our GitHub page, or split your grand new ideas in our chats.
 
-## Contributing
+## Contributions
 
-Please check out the [Contributing to RATH guide](https://kanaries.net/docs/contribution_guide)
+Please check out the [Contributing to RATH guide](https://docs.kanaries.net/contribution-guide)
 for guidelines about how to proceed.
 
 Thanks to all contributors :heart: