LucienShen-Liu commented on code in PR #844:
URL: 
https://github.com/apache/incubator-seata-go/pull/844#discussion_r2174055269


##########
README.md:
##########
@@ -1,69 +1,152 @@
-<!--
-    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

Review Comment:
   done



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@seata.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@seata.apache.org
For additional commands, e-mail: notifications-h...@seata.apache.org

Reply via email to