docs: eEnrich the project ReadMe (#844)

* docs: eEnrich the project ReadMe * docs: eEnrich the project ReadMe * docs: eEnrich the project ReadMe * docs: Increase the version number so that users can find the latest version. * Update README_ZH.md --------- Co-authored-by: FengZhang <zfcode@qq.com> Co-authored-by: FinnTew <finntew@foxmail.com>
2 months ago · d30ffd6f3d
--- a/README.md
+++ b/README.md
@@ -1,69 +1,161 @@
 <!--
    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0
    
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
 <!--  
    Licensed to the Apache Software Foundation (ASF) under one or more  
    contributor license agreements.  See the NOTICE file distributed with  
    this work for additional information regarding copyright ownership.  
    The ASF licenses this file to You under the Apache License, Version 2.0  
    (the "License"); you may not use this file except in compliance with  
    the License.  You may obtain a copy of the License at  
  
    http://www.apache.org/licenses/LICENSE-2.0  
      
    Unless required by applicable law or agreed to in writing, software  
    distributed under the License is distributed on an "AS IS" BASIS,  
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
    See the License for the specific language governing permissions and  
    limitations under the License.  
 -->
 <div style="align: center">
 <img src="https://img.alicdn.com/imgextra/i1/O1CN011z0JfQ2723QgDiWuH_!!6000000007738-2-tps-1497-401.png"  height="100" width="426"/>
 </div>

 # Seata-go: Simple Extensible Autonomous Transaction Architecture(Go version)

 [![CI](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml/badge.svg)](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml)
 [![![CI](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml/badge.svg)](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml)  
 [![license](https://img.shields.io/github/license/apache/incubator-seata-go.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

 [简体中文 ZH](./README_ZH.md)
 ## What is seata-go?
 ## What is Seata-go?

 Apache Seata(incubating) is a very mature distributed transaction framework, and is the de facto standard platform for distributed transaction technology in the Java field. Seata-go is the implementation version of go language in Seata multilingual ecosystem, which realizes the interoperability between Java and Go, so that Go developers can also use seata-go to realize distributed transactions. Please visit the [official website of Seata](https://seata.apache.org/) to view the quick start and documentation.

 The principle of seata-go is consistent with that of Seata-java, which is composed of TM, RM and TC. The functions of TC reuse Java, and the functions of TM and RM will be aligned with Seata-java later. The overall process is as follows:

 ![](https://user-images.githubusercontent.com/68344696/145942191-7a2d469f-94c8-4cd2-8c7e-46ad75683636.png)

 ## TODO list

 - [x] TCC
 - [x] XA
 - [x] AT
  - [x] Insert SQL
  - [x] Delete SQL
  - [x] Insert on update SQL
  - [x] Multi update SQL
  - [x] Multi delete SQL
  - [x] Select for update SQL
  - [x] Update SQL
 - [ ] SAGA
 - [x] TM
 - [x] RPC communication
 - [x] Transaction anti suspension
  - [x] Manually way
  - [x] Proxy datasource way 
 - [x] Null compensation
 - [x] Configuration center
  - [x] Configuration file
 - [x] Registration Center
 - [ ] Metric monitoring
 - [x] Compressor algorithm
 - [x] Examples
 The principle of seata-go is consistent with that of Seata-java, which is composed of TM, RM and TC. The functions of TC are reused in Java, and the functions of TM and RM have been connected with Seata-java.
 ### Distributed Transaction Problem in Microservices

 Let's imagine a traditional monolithic application. Its business is built up with 3 modules. They use a single local data source.

 Naturally, data consistency will be guaranteed by the local transaction.

 ![Monolithic App](https://img.alicdn.com/imgextra/i3/O1CN01FTtjyG1H4vvVh1sNY_!!6000000000705-0-tps-1106-678.jpg)

 Things have changed in a microservices architecture. The 3 modules mentioned above are designed to be 3 services on top of 3 different data sources ([Pattern: Database per service](http://microservices.io/patterns/data/database-per-service.html)). Data consistency within every single service is naturally guaranteed by the local transaction.

 **But how about the whole business logic scope?**

 ![Microservices Problem](https://img.alicdn.com/imgextra/i1/O1CN01DXkc3o1te9mnJcHOr_!!6000000005926-0-tps-1268-804.jpg)

 ### How Seata-go do?

 Seata-go is just a solution to the problem mentioned above.

 ![Seata solution](https://img.alicdn.com/imgextra/i1/O1CN01FheliH1k5VHIRob3p_!!6000000004632-0-tps-1534-908.jpg)

 Firstly, how to define a **Distributed Transaction**?

 We say, a **Distributed Transaction** is a **Global Transaction** which is made up with a batch of **Branch Transaction**, and normally **Branch Transaction** is just **Local Transaction**.

 ![Global & Branch](https://cdn.nlark.com/lark/0/2018/png/18862/1545015454979-a18e16f6-ed41-44f1-9c7a-bd82c4d5ff99.png)

 There are three roles in Seata-go:

 - **Transaction Coordinator(TC):** Maintain status of global and branch transactions, drive the global commit or rollback.
 - **Transaction Manager(TM):** Define the scope of global transaction: begin a global transaction, commit or rollback a global transaction.
 - **Resource Manager(RM):** Manage resources that branch transactions working on, talk to TC for registering branch transactions and reporting status of branch transactions, and drive the branch transaction commit or rollback.

 ![Model](https://cdn.nlark.com/lark/0/2018/png/18862/1545013915286-4a90f0df-5fda-41e1-91e0-2aa3d331c035.png)

 A typical lifecycle of Seata-go managed distributed transaction:

 1. TM asks TC to begin a new global transaction. TC generates an XID representing the global transaction.
 2. XID is propagated through microservices' invoke chain.
 3. RM registers local transaction as a branch of the corresponding global transaction of XID to TC.
 4. TM asks TC for committing or rollbacking the corresponding global transaction of XID.
 5. TC drives all branch transactions under the corresponding global transaction of XID to finish branch committing or rollbacking.

 ![Typical Process](https://cdn.nlark.com/lark/0/2018/png/18862/1545296917881-26fabeb9-71fa-4f3e-8a7a-fc317d3389f4.png)

 For more details about principle and design, please go to [Seata wiki page](https://github.com/apache/incubator-seata/wiki).

 ### History

 ##### Alibaba

 - **TXC**: Taobao Transaction Constructor. Alibaba middleware team started this project since 2014 to meet the distributed transaction problems caused by application architecture change from monolithic to microservices.
 - **GTS**: Global Transaction Service. TXC as an Aliyun middleware product with new name GTS was published since 2016.
 - **Fescar**: we started the open source project Fescar based on TXC/GTS since 2019 to work closely with the community in the future.


 ##### Ant Financial

 - **XTS**: Extended Transaction Service. Ant Financial middleware team developed the distributed transaction middleware since 2007, which is widely used in Ant Financial and solves the problems of data consistency across databases and services.

 - **DTX**: Distributed Transaction Extended. Since 2013, XTS has been published on the Ant Financial Cloud, with the name of DTX .


 ##### Seata Community

 - **Seata** :Simple Extensible Autonomous Transaction Architecture. Ant Financial joins Fescar, which make it to be a more neutral and open community for distributed transaction, and Fescar be renamed to Seata.



 ## How to run？

 ```go
 go get seata.apache.org/seata-go@v2.0.0

 ```

 if you want to know how to use and integrate seata-go, please refer to [apache/seata-go-samples](https://github.com/apache/incubator-seata-go-samples)

 ## How to join us？
 ## How to find the latest version
 Visit Seata-Go's GitHub Releases page

 Open:
 https://github.com/seata/seata-go/releases

 The latest tag / release is the latest stable version.


 ## Documentation


 You can view the full documentation from Seata Official Website: [Seata Website page](https://seata.apache.org/zh-cn/docs/overview/what-is-seata).

 ## Reporting bugs

 Please follow the [template](.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md) for reporting any issues.

 ## Security

 Please do not use our public issue tracker but refer to our [security policy](https://github.com/apache/incubator-seata/blob/2.x/SECURITY.md)

 ## Contributing

 Seata-go is currently in the construction stage. Welcome colleagues in the industry to join the group and work with us to promote the construction of seata-go! If you want to contribute code to seata-go, you can refer to the  [**code contribution Specification**](./CONTRIBUTING_CN.md)  document to understand the specifications of the community, or you can join our community DingTalk group: 33069364 and communicate together!

 ## Licence

 Seata-go uses Apache license version 2.0. Please refer to the license file for more information.
 ## Contact

 * Mailing list:
  * dev@seata.apache.org , for dev/user discussion. [subscribe](mailto:dev-subscribe@seata.apache.org), [unsubscribe](mailto:dev-unsubscribe@seata.apache.org), [archive](https://lists.apache.org/list.html?dev@seata.apache.org)
 * Online chat:

 |                                                       Dingtalk group                                                        |                                                   Wechat official account                                                    |                                                       QQ group                                                        |                                                  Wechat assistant                                                   |
 |:---------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------:|
 | <img src="https://seata.apache.org/zh-cn/assets/images/dingtalk-group-67f42c9466fb2268b6927bb16b549d6c.jpg"  width="150" /> | <img src="https://seata.apache.org/zh-cn/assets/images/wechat-official-467d10305f5449e6b2096e65d23a9d02.jpg"  width="150" /> | <img src="https://seata.apache.org/zh-cn/assets/images/qq-group-8d8a89699cdb9ba8818364069475ba96.jpg"  width="150" /> | <img src="https://seata.apache.org/zh-cn/assets/images/wechat-f8a87a96973942b826e32d1aed9bc8d9.jpg"  width="150" /> |

 ## Seata ecosystem

 * [Seata Website](https://github.com/apache/incubator-seata.github.io) - Seata official website
 * [Seata](https://github.com/apache/incubator-seata)- Seata client and server
 * [Seata GoLang](https://github.com/apache/incubator-seata-go) - Seata GoLang client and server
 * [Seata Samples](https://github.com/apache/incubator-seata-samples) - Samples for Seata
 * [Seata GoLang Samples](https://github.com/apache/incubator-seata-go-samples) - Samples for Seata GoLang
 * [Seata K8s](https://github.com/apache/incubator-seata-k8s) - Seata integration with k8s
 * [Seata CLI](https://github.com/apache/incubator-seata-ctl) - CLI tool for Seata

 ## Contributors

 This project exists thanks to all the people who contribute. [[Contributors](https://github.com/apache/incubator-seata-go/graphs/contributors)].

 ## License

 Seata-go is under the Apache 2.0 license. See the [LICENSE](https://github.com/apache/incubator-seata-go/blob/master/LICENSE) file for details.
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -1,72 +1,168 @@
 <!--
    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0
    
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

 <!--  
    Licensed to the Apache Software Foundation (ASF) under one or more  
    contributor license agreements.  See the NOTICE file distributed with  
    this work for additional information regarding copyright ownership.  
    The ASF licenses this file to You under the Apache License, Version 2.0  
    (the "License"); you may not use this file except in compliance with  
    the License.  You may obtain a copy of the License at  
  
    http://www.apache.org/licenses/LICENSE-2.0  
      
    Unless required by applicable law or agreed to in writing, software  
    distributed under the License is distributed on an "AS IS" BASIS,  
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
    See the License for the specific language governing permissions and  
    limitations under the License.  
 -->
 # seata-go: 简单的可扩展自主事务架构(Go版本)
 <div style="align: center">

 <img src="https://img.alicdn.com/imgextra/i1/O1CN011z0JfQ2723QgDiWuH_!!6000000007738-2-tps-1497-401.png" height="100" width="426"/>

 </div>
 # Seata-go：简单可扩展的自主事务架构（Go 语言版本）

 [![![CI](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml/badge.svg)](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml) 

 [![CI](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml/badge.svg)](https://github.com/apache/incubator-seata-go/actions/workflows/license.yml)
 [![license](https://img.shields.io/github/license/apache/incubator-seata-go.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

 [English US](./README.md)
 [简体中文 ZH](./README_ZH.md)

 ## 什么是 Seata-go？



 Apache Seata（incubating）是一个非常成熟的分布式事务框架，是 Java 领域事实上的标准分布式事务平台。Seata-go 是其在多语言生态中 Go 语言的实现版本，实现了 Java 与 Go 之间的互操作，使得 Go 开发者也可以使用 seata-go 实现分布式事务。请访问 [Seata 官网](https://seata.apache.org/) 获取快速入门和文档。

 Seata-go 的原理与 Seata-java 一致，由 TM、RM 和 TC 三部分组成。其中 TC 功能复用 Java 的实现，而 TM 和 RM 则已与 Seata-java 对接。

 ### 微服务中的分布式事务问题

 假设我们有一个传统的单体应用，其业务由三个模块组成，使用一个本地数据源，自然由本地事务保障数据一致性。
 ![Monolithic App](https://img.alicdn.com/imgextra/i3/O1CN01FTtjyG1H4vvVh1sNY_!!6000000000705-0-tps-1106-678.jpg)
 但在微服务架构中，这三个模块被设计成了三个不同的服务，分别使用不同的数据源（[数据库每服务模式](http://microservices.io/patterns/data/database-per-service.html)）。单个服务内的数据一致性可以通过本地事务保障。

 但**整个业务范围的一致性如何保障？**
 ![Microservices Problem](https://img.alicdn.com/imgextra/i1/O1CN01DXkc3o1te9mnJcHOr_!!6000000005926-0-tps-1268-804.jpg)


 ### Seata-go 如何做？

 Seata-go 就是为了解决上述问题而生。
 ![Seata solution](https://img.alicdn.com/imgextra/i1/O1CN01FheliH1k5VHIRob3p_!!6000000004632-0-tps-1534-908.jpg)
 首先，如何定义一个**分布式事务**？
 我们认为，分布式事务是一个**全局事务**，由一组**分支事务**组成，而**分支事务**通常就是**本地事务**。
 ![Global & Branch](https://cdn.nlark.com/lark/0/2018/png/18862/1545015454979-a18e16f6-ed41-44f1-9c7a-bd82c4d5ff99.png)


 Seata-go 中有三个角色：

 - **事务协调器（TC）**：维护全局和分支事务的状态，驱动全局提交或回滚。

 - **事务管理器（TM）**：定义全局事务的范围，开始、提交或回滚全局事务。

 - **资源管理器（RM）**：管理分支事务所处理的资源，与 TC 通信注册分支事务并报告状态，驱动分支事务提交或回滚。
  ![Model](https://cdn.nlark.com/lark/0/2018/png/18862/1545013915286-4a90f0df-5fda-41e1-91e0-2aa3d331c035.png)


 Seata-go 分布式事务的典型生命周期如下：



 1. TM 请求 TC 开启一个新的全局事务，TC 生成表示全局事务的 XID。

 2. XID 在微服务调用链中传播。

 3. RM 将本地事务注册为该 XID 对应的全局事务的分支事务。

 4. TM 请求 TC 提交或回滚该 XID 对应的全局事务。

 5. TC 驱动该 XID 对应的所有分支事务进行提交或回滚。

 ![Typical Process](https://cdn.nlark.com/lark/0/2018/png/18862/1545296917881-26fabeb9-71fa-4f3e-8a7a-fc317d3389f4.png)

 更多原理和设计细节，请参阅 [Seata Wiki 页面](https://github.com/apache/incubator-seata/wiki)。



 ### 历史背景

 ##### 阿里巴巴

 - **TXC**：淘宝事务构建器。2014 年阿里中间件团队启动，用于应对从单体架构转向微服务带来的分布式事务问题。

 - **GTS**：全局事务服务。2016 年 TXC 在阿里云上线，更名为 GTS。

 - **Fescar**：2019 年开始基于 TXC/GTS 启动开源项目 Fescar，与社区合作。

 ##### 蚂蚁金服

 - **XTS**：扩展事务服务。自 2007 年开始开发的分布式事务中间件，被广泛应用于蚂蚁金服，解决跨库跨服务数据一致性问题。

 - **DTX**：分布式事务扩展。2013 年起在蚂蚁金服云发布，命名为 DTX。
 ##### Seata 社区

 - **Seata**：简单可扩展的自主事务架构。蚂蚁金服加入 Fescar，使其成为一个更加中立开放的社区，Fescar 更名为 Seata。

 ## 如何运行？
 ```go

 go get seata.apache.org/seata-go@2.0.0 

 ```
 如果你想了解如何使用和集成 seata-go，请参考 [apache/seata-go-samples](https://github.com/apache/incubator-seata-go-samples)
 ## 如何查找最新版本
 访问 Seata-Go 的 GitHub Releases 页面

 打开：https://github.com/seata/seata-go/releases

 最新的 tag / release 就是目前的最新稳定版本。
 ## 文档

 你可以访问 Seata 官方网站获取完整文档：[Seata 官网](https://seata.apache.org/zh-cn/docs/overview/what-is-seata)
 ## 问题报告

 若有问题，请遵循 [模板](./.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md) 报告问题。

 ## 安全

 请勿使用公开的问题跟踪器，详情请参阅我们的 [安全政策](https://github.com/apache/incubator-seata/blob/2.x/SECURITY.md)

 ## 参与贡献
 Seata-go 当前处于建设阶段，欢迎业界同仁加入我们，共同推进 Seata-go 建设！如果你想为 Seata-go 贡献代码，请参考 [代码贡献规范](./CONTRIBUTING_CN.md)，也可以加入我们的社区钉钉群：33069364 一起交流！

 ## 联系方式

 * 邮件列表：  

   * dev@seata.apache.org - 用于开发/用户讨论   [订阅](mailto:dev-subscribe@seata.apache.org)、[取消订阅](mailto:dev-unsubscribe@seata.apache.org)、[归档](https://lists.apache.org/list.html?dev@seata.apache.org)

 ## 什么是 seata-go？
 * 在线交流：  

 Apache Seata(incubating) 是一个非常成熟的分布式事务框架，在 Java 领域是事实上的分布式事务技术标准平台。Seata-go 是 seata 多语言生态中的 Go 语言实现版本，实现了 Java 和 Go 之间的互通，让 Go 开发者也能使用 seata-go 来实现分布式事务。请访问[Seata 官网](https://seata.apache.org/zh-cn/)查看快速开始和文档。
 |                                                             钉钉                                                              |                                                            微信公众号                                                             |                                                          QQ                                                           |                                                        微信助手                                                         |
 |:---------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------:|
 | <img src="https://seata.apache.org/zh-cn/assets/images/dingtalk-group-67f42c9466fb2268b6927bb16b549d6c.jpg"  width="150" /> | <img src="https://seata.apache.org/zh-cn/assets/images/wechat-official-467d10305f5449e6b2096e65d23a9d02.jpg"  width="150" /> | <img src="https://seata.apache.org/zh-cn/assets/images/qq-group-8d8a89699cdb9ba8818364069475ba96.jpg"  width="150" /> | <img src="https://seata.apache.org/zh-cn/assets/images/wechat-f8a87a96973942b826e32d1aed9bc8d9.jpg"  width="150" /> |

 Seata-go 的原理和 Seata-java 保持一致，都是由 TM、RM 和 TC 组成，其中 TC 的功能复用 Java 的，TM 和 RM 功能后面会和 Seata-java 对齐，整体流程如下：

 ![](https://user-images.githubusercontent.com/68344696/145942191-7a2d469f-94c8-4cd2-8c7e-46ad75683636.png)
 ## Seata 生态系统

 ## 待办事项
 * [Seata 官网](https://github.com/apache/incubator-seata.github.io)- Seata官方网站

 - [x] TCC
 - [x] XA
 - [x] AT
  - [x] Insert SQL
  - [x] Delete SQL
  - [x] Insert on update SQL
  - [x] Multi update SQL
  - [x] Multi delete SQL
  - [x] Select for update SQL
  - [x] Update SQL
 - [ ] SAGA
 - [x] TM
 - [x] RPC 通信
 - [x] 事务防悬挂
  - [x] 手动方式
  - [x] 代理数据源方式
 - [x] 空补偿
  - [x] 手动方式
  - [x] 代理数据源方式
 - [x] 配置中心
  - [x] 配置文件
 - [x] 注册中心
 - [ ] Metric 监控
 - [x] 压缩算法
 - [x] Sample 例子
 * [Seata](https://github.com/apache/incubator-seata) - Seata 客户端和服务端

 * [Seata GoLang](https://github.com/apache/incubator-seata-go) - Seata Go 客户端和服务端

 ## 如何运行项目？
 * [Seata 示例](https://github.com/apache/incubator-seata-samples)- Seata 示例

 关于如何使用和集成 seata-go 的示例，可以参考 [apache/seata-go-samples](https://github.com/apache/incubator-seata-go-samples)
 * [Seata Go 示例](https://github.com/apache/incubator-seata-go-samples)- Seata GoLang 示例

 * [Seata K8s 集成](https://github.com/apache/incubator-seata-k8s)- Seata 与 K8S 集成

 ## 如何给Seata-go贡献代码？
 * [Seata 命令行工具](https://github.com/apache/incubator-seata-ctl)- Seata CLI 工具

 Seata-go 目前正在建设阶段，欢迎行业同仁入群参与其中，与我们一起推动 seata-go 的建设！如果你想给 seata-go 贡献代码，可以参考 **[代码贡献规范](./CONTRIBUTING.md)** 文档来了解社区的规范，也可以加入我们的社区钉钉群：33069364，一起沟通交流！
 ## 贡献者

 ## 协议
 Seata-go感谢所有贡献者的付出。[[贡献者列表](https://github.com/apache/incubator-seata-go/graphs/contributors)]
 ## 许可证

 Seata-go 使用 Apache 许可证2.0版本，请参阅 LICENSE 文件了解更多。
 Seata-go 使用 Apache 2.0 协议，详情请查看 [LICENSE 文件](https://github.com/apache/incubator-seata-go/blob/master/LICENSE)