From 7c566fbb7f729a35cf1398551b384df90e57c8bd Mon Sep 17 00:00:00 2001
From: yedf2 <120050102@qq.com>
Date: Mon, 27 Sep 2021 11:02:28 +0800
Subject: [PATCH] change to default cn
---
README-cn.md | 119 ----------------------------------------
README-en.md | 124 ++++++++++++++++++++++++++++++++++++++++++
README.md | 151 +++++++++++++++++++++++++--------------------------
3 files changed, 197 insertions(+), 197 deletions(-)
delete mode 100644 README-cn.md
create mode 100644 README-en.md
diff --git a/README-cn.md b/README-cn.md
deleted file mode 100644
index 6cfb630..0000000
--- a/README-cn.md
+++ /dev/null
@@ -1,119 +0,0 @@
-
-[](https://travis-ci.com/yedf/dtm)
-[](https://coveralls.io/github/yedf/dtm?branch=main)
-[](https://goreportcard.com/report/github.com/yedf/dtm)
-[](https://pkg.go.dev/github.com/yedf/dtm)
-[](https://github.com/avelino/awesome-go#database)
-
-# [English Docs](https://en.dtm.pub)
-# GO语言分布式事务管理服务
-
-DTM是首款golang的开源分布式事务管理器，优雅的解决了幂等、空补偿、悬挂等分布式事务难题。提供了简单易用、高性能、易水平扩展的分布式事务解决方案。
-
-受邀参加中国数据库大会分享[多语言环境下分布式事务实践](http://dtcc.it168.com/yicheng.html#b9)
-
-## 谁在使用dtm
-
-[Ivydad 常青藤爸爸](https://ivydad.com)
-
-[Eglass 视咖镜小二](https://epeijing.cn)
-
-[极欧科技](http://jiou.me)
-
-[金数智联]()
-
-## 亮点
-
-* 极易接入
- - 支持HTTP，提供非常简单的接口，极大降低上手分布式事务的难度，新手也能快速接入
-* 使用简单
- - 开发者不再担心悬挂、空补偿、幂等各类问题，框架层代为处理
-* 跨语言
- - 可适合多语言栈的公司使用。方便go、python、php、nodejs、ruby、c# 各类语言使用。
-* 易部署、易扩展
- - 仅依赖mysql，部署简单，易集群化，易水平扩展
-* 多种分布式事务协议支持
- - TCC、SAGA、XA、事务消息
-
-## 与其他框架对比
-
-目前开源的分布式事务框架，暂未看到非Java语言有成熟的框架。而Java语言的较多，有阿里的SEATA、华为的ServiceComb-Pack，京东的shardingsphere，以及himly，tcc-transaction，ByteTCC等等，其中以seata应用最为广泛。
-
-下面是dtm和seata的主要特性对比：
-
-| 特性| DTM | SEATA |备注|
-|:-----:|:----:|:----:|:----:|
-| 支持语言 |Go、Java、python、php、c#...|Java|dtm可轻松接入一门新语言|
-|异常处理| [子事务屏障自动处理](https://zhuanlan.zhihu.com/p/388444465) |手动处理 |dtm解决了幂等、悬挂、空补偿|
-| TCC事务| ✓|✓||
-| XA事务|✓|✓||
-|AT事务|✗|✓|AT与XA类似，性能更好，但有脏回滚|
-| SAGA事务 |简单模式 |状态机复杂模式 |dtm的状态机模式在规划中|
-|事务消息|✓|✗|dtm提供类似rocketmq的事务消息|
-|通信协议|HTTP、GRPC|dubbo等协议，无HTTP|dtm对云原生更加友好|
-|star数量|
|
|dtm从20210604发布0.1，发展快|
-
-从上面对比的特性来看，如果您的语言栈包含了Java之外的语言，那么dtm是您的首选。如果您的语言栈是Java，您也可以选择接入dtm，使用子事务屏障技术，简化您的业务编写。
-
-## [教程与文档](https://dtm.pub)
-
-## [各语言客户端及示例](https://dtm.pub/summary/code.html#go)
-
-## 快速开始
-
-### 安装
-
-`git clone https://github.com/yedf/dtm`
-
-### dtm依赖于mysql
-
-配置mysql：
-
-`cp conf.sample.yml conf.yml # 修改conf.yml`
-
-### 启动并运行saga示例
-`go run app/main.go saga`
-
-## 开始使用
-
-### 使用
-``` GO
- // 具体业务微服务地址
- const qsBusi = "http://localhost:8081/api/busi_saga"
- req := &gin.H{"amount": 30} // 微服务的载荷
- // DtmServer为DTM服务的地址，是一个url
- DtmServer := "http://localhost:8080/api/dtmsvr"
- saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)).
- // 添加一个TransOut的子事务，正向操作为url: qsBusi+"/TransOut"， 补偿操作为url: qsBusi+"/TransOutCompensate"
- Add(qsBusi+"/TransOut", qsBusi+"/TransOutCompensate", req).
- // 添加一个TransIn的子事务，正向操作为url: qsBusi+"/TransIn"， 补偿操作为url: qsBusi+"/TransInCompensate"
- Add(qsBusi+"/TransIn", qsBusi+"/TransInCompensate", req)
- // 提交saga事务，dtm会完成所有的子事务/回滚所有的子事务
- err := saga.Submit()
-```
-
-成功运行后，可以看到TransOut、TransIn依次被调用，完成了整个分布式事务
-
-### 时序图
-
-上述saga分布式事务的时序图如下：
-
-
-
-### 完整示例
-参考[examples/quick_start.go](./examples/quick_start.go)
-
-## 交流群
-请加 yedf2008 好友或者扫码加好友，验证回复 dtm 按照指引进群
-
-
-
-如果您觉得[dtm](https://github.com/yedf/dtm)不错，或者对您有帮助，请赏颗星吧！
-
-## 谁在使用
-
diff --git a/README-en.md b/README-en.md
new file mode 100644
index 0000000..ab9568c
--- /dev/null
+++ b/README-en.md
@@ -0,0 +1,124 @@
+
+[](https://travis-ci.com/yedf/dtm)
+[](https://coveralls.io/github/yedf/dtm?branch=main)
+[](https://goreportcard.com/report/github.com/yedf/dtm)
+[](https://pkg.go.dev/github.com/yedf/dtm)
+[](https://github.com/avelino/awesome-go#database)
+
+# [中文文档](http://dtm.pub)
+
+# A Cross Language Transaction Manager
+
+## Who's using DTM
+
+[Ivydad](https://ivydad.com)
+
+[Eglass](https://epeijing.cn)
+
+[Jiou](http://jiou.me)
+
+[GoldenData]()
+
+## What is DTM
+
+DTM is the first distributed transaction management framework in Golang. Unlike other frameworks, DTM provides extremely easy access interfaces of HTTP and gRPC, supports multiple language bindings, and handles tricky problems of unordered sub-transactions at the framework level.
+
+## Features
+
+* Extremely easy to adapt
+ - Support HTTP and gRPC, provide easy-to-use programming interfaces, lower substantially the barrier of getting started with distributed transactions. Newcomers can adapt quickly.
+
+* Easy to use
+ - Relieving developers from worrying about suspension, null compensation, idempotent transaction, and other tricky problems, the framework layer handles them all.
+
+* Language-agnostic
+ - Suit for companies with multiple-language stacks.
+ Easy to write bindings for Go, Python, PHP, Node.js, Ruby, and other languages.
+
+* Easy to deploy, easy to extend
+ - DTM depends only on MySQL, easy to deploy, cluster, and scale horizontally.
+
+* Support for multiple distributed transaction protocol
+ - TCC, SAGA, XA, Transactional messages.
+
+## DTM vs. others
+
+There is no mature open-source distributed transaction framework for non-Java languages.
+Mature open-source distributed transaction frameworks for Java language include Ali's Seata, Huawei's ServiceComb-Pack, Jingdong's shardingsphere, himly, tcc-transaction, ByteTCC, and so on, of which Seata is most widely used.
+
+The following is a comparison of the main features of dtm and Seata.
+
+
+| Features | DTM | Seata | Remarks |
+| :-----: | :----: | :----: | :----: |
+| Supported languages | Golang, Python, PHP, and others | Java | dtm allows easy access from a new language |
+| Exception handling | [Sub-transaction barrier](https://zhuanlan.zhihu.com/p/388444465) | manual | dtm solves idempotent transaction, hanging, null compensation |
+| TCC | ✓ | ✓ | |
+| XA | ✓ | ✓ | |
+| AT | ✗ | ✓ | AT is similar to XA with better performance but with dirty rollback |
+| SAGA | Simple mode | complicated state-machine mode | dtm's state-machine mode is being planned |
+| Transactional Messaging | ✓ | ✗ | dtm provides Transactional Messaging similar to RocketMQ |
+| Communication protocols | HTTP, gRPC | Dubbo, no HTTP | |
+| Star count | | | dtm 0.1 is released from 20210604 and under fast development |
+
+From the features' comparison above, if your language stack includes languages other than Java, then dtm is the one for you.
+If your language stack is Java, you can also choose to access dtm and use sub-transaction barrier technology to simplify your business development.
+
+## [Cook Book](https://en.dtm.pub)
+
+# Quick start
+
+### Install
+
+`git clone https://github.com/yedf/dtm`
+
+### Configure Mysql
+
+`cp conf.sample.yml conf.yml # Modify conf.yml`
+
+### Start the example
+`go run app/main.go`
+
+# Code
+
+### Use
+``` go
+ // business micro-service address
+ const qsBusi = "http://localhost:8081/api/busi_saga"
+ // The address where DtmServer serves DTM, which is a url
+ DtmServer := "http://localhost:8080/api/dtmsvr"
+ req := &gin.H{"amount": 30} // micro-service payload
+ // DtmServer is the address of DTM micro-service
+ saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)).
+ // add a TransOut subtraction，forward operation with url: qsBusi+"/TransOut", reverse compensation operation with url: qsBusi+"/TransOutCompensate"
+ Add(qsBusi+"/TransOut", qsBusi+"/TransOutCompensate", req).
+ // add a TransIn subtraction, forward operation with url: qsBusi+"/TransIn", reverse compensation operation with url: qsBusi+"/TransInCompensate"
+ Add(qsBusi+"/TransIn", qsBusi+"/TransInCompensate", req)
+ // submit the created saga transaction，dtm ensures all subtractions either complete or get revoked
+ err := saga.Submit()
+```
+### Complete example
+
+Refer to [examples/quick_start.go](./examples/quick_start.go).
+
+### Slack
+
+You can join the [DTM slack channel here](https://join.slack.com/t/dtm-w6k9662/shared_invite/zt-vkrph4k1-eFqEFnMkbmlXqfUo5GWHWw).
+
+### Wechat
+
+Add wechat friend with id yedf2008, or scan the OR code. Fill in dtm as verification.
+
+
+
+### Give a star! ⭐
+
+If you think this project is good, or helpful to you, please give a star!
+
+### Who is using
+
diff --git a/README.md b/README.md
index ab9568c..6cfb630 100644
--- a/README.md
+++ b/README.md
@@ -5,120 +5,115 @@
[](https://pkg.go.dev/github.com/yedf/dtm)
[](https://github.com/avelino/awesome-go#database)
-# [中文文档](http://dtm.pub)
+# [English Docs](https://en.dtm.pub)
+# GO语言分布式事务管理服务
-# A Cross Language Transaction Manager
+DTM是首款golang的开源分布式事务管理器，优雅的解决了幂等、空补偿、悬挂等分布式事务难题。提供了简单易用、高性能、易水平扩展的分布式事务解决方案。
-## Who's using DTM
+受邀参加中国数据库大会分享[多语言环境下分布式事务实践](http://dtcc.it168.com/yicheng.html#b9)
-[Ivydad](https://ivydad.com)
+## 谁在使用dtm
-[Eglass](https://epeijing.cn)
+[Ivydad 常青藤爸爸](https://ivydad.com)
-[Jiou](http://jiou.me)
+[Eglass 视咖镜小二](https://epeijing.cn)
-[GoldenData]()
+[极欧科技](http://jiou.me)
-## What is DTM
+[金数智联]()
-DTM is the first distributed transaction management framework in Golang. Unlike other frameworks, DTM provides extremely easy access interfaces of HTTP and gRPC, supports multiple language bindings, and handles tricky problems of unordered sub-transactions at the framework level.
+## 亮点
-## Features
+* 极易接入
+ - 支持HTTP，提供非常简单的接口，极大降低上手分布式事务的难度，新手也能快速接入
+* 使用简单
+ - 开发者不再担心悬挂、空补偿、幂等各类问题，框架层代为处理
+* 跨语言
+ - 可适合多语言栈的公司使用。方便go、python、php、nodejs、ruby、c# 各类语言使用。
+* 易部署、易扩展
+ - 仅依赖mysql，部署简单，易集群化，易水平扩展
+* 多种分布式事务协议支持
+ - TCC、SAGA、XA、事务消息
-* Extremely easy to adapt
- - Support HTTP and gRPC, provide easy-to-use programming interfaces, lower substantially the barrier of getting started with distributed transactions. Newcomers can adapt quickly.
+## 与其他框架对比
-* Easy to use
- - Relieving developers from worrying about suspension, null compensation, idempotent transaction, and other tricky problems, the framework layer handles them all.
+目前开源的分布式事务框架，暂未看到非Java语言有成熟的框架。而Java语言的较多，有阿里的SEATA、华为的ServiceComb-Pack，京东的shardingsphere，以及himly，tcc-transaction，ByteTCC等等，其中以seata应用最为广泛。
-* Language-agnostic
- - Suit for companies with multiple-language stacks.
- Easy to write bindings for Go, Python, PHP, Node.js, Ruby, and other languages.
+下面是dtm和seata的主要特性对比：
-* Easy to deploy, easy to extend
- - DTM depends only on MySQL, easy to deploy, cluster, and scale horizontally.
+| 特性| DTM | SEATA |备注|
+|:-----:|:----:|:----:|:----:|
+| 支持语言 |Go、Java、python、php、c#...|Java|dtm可轻松接入一门新语言|
+|异常处理| [子事务屏障自动处理](https://zhuanlan.zhihu.com/p/388444465) |手动处理 |dtm解决了幂等、悬挂、空补偿|
+| TCC事务| ✓|✓||
+| XA事务|✓|✓||
+|AT事务|✗|✓|AT与XA类似，性能更好，但有脏回滚|
+| SAGA事务 |简单模式 |状态机复杂模式 |dtm的状态机模式在规划中|
+|事务消息|✓|✗|dtm提供类似rocketmq的事务消息|
+|通信协议|HTTP、GRPC|dubbo等协议，无HTTP|dtm对云原生更加友好|
+|star数量|||dtm从20210604发布0.1，发展快|
-* Support for multiple distributed transaction protocol
- - TCC, SAGA, XA, Transactional messages.
+从上面对比的特性来看，如果您的语言栈包含了Java之外的语言，那么dtm是您的首选。如果您的语言栈是Java，您也可以选择接入dtm，使用子事务屏障技术，简化您的业务编写。
-## DTM vs. others
+## [教程与文档](https://dtm.pub)
-There is no mature open-source distributed transaction framework for non-Java languages.
-Mature open-source distributed transaction frameworks for Java language include Ali's Seata, Huawei's ServiceComb-Pack, Jingdong's shardingsphere, himly, tcc-transaction, ByteTCC, and so on, of which Seata is most widely used.
+## [各语言客户端及示例](https://dtm.pub/summary/code.html#go)
-The following is a comparison of the main features of dtm and Seata.
+## 快速开始
-
-| Features | DTM | Seata | Remarks |
-| :-----: | :----: | :----: | :----: |
-| Supported languages | Golang, Python, PHP, and others | Java | dtm allows easy access from a new language |
-| Exception handling | [Sub-transaction barrier](https://zhuanlan.zhihu.com/p/388444465) | manual | dtm solves idempotent transaction, hanging, null compensation |
-| TCC | ✓ | ✓ | |
-| XA | ✓ | ✓ | |
-| AT | ✗ | ✓ | AT is similar to XA with better performance but with dirty rollback |
-| SAGA | Simple mode | complicated state-machine mode | dtm's state-machine mode is being planned |
-| Transactional Messaging | ✓ | ✗ | dtm provides Transactional Messaging similar to RocketMQ |
-| Communication protocols | HTTP, gRPC | Dubbo, no HTTP | |
-| Star count | | | dtm 0.1 is released from 20210604 and under fast development |
-
-From the features' comparison above, if your language stack includes languages other than Java, then dtm is the one for you.
-If your language stack is Java, you can also choose to access dtm and use sub-transaction barrier technology to simplify your business development.
-
-## [Cook Book](https://en.dtm.pub)
-
-# Quick start
-
-### Install
+### 安装
`git clone https://github.com/yedf/dtm`
-### Configure Mysql
+### dtm依赖于mysql
-`cp conf.sample.yml conf.yml # Modify conf.yml`
+配置mysql：
-### Start the example
-`go run app/main.go`
+`cp conf.sample.yml conf.yml # 修改conf.yml`
-# Code
+### 启动并运行saga示例
+`go run app/main.go saga`
-### Use
-``` go
- // business micro-service address
+## 开始使用
+
+### 使用
+``` GO
+ // 具体业务微服务地址
const qsBusi = "http://localhost:8081/api/busi_saga"
- // The address where DtmServer serves DTM, which is a url
+ req := &gin.H{"amount": 30} // 微服务的载荷
+ // DtmServer为DTM服务的地址，是一个url
DtmServer := "http://localhost:8080/api/dtmsvr"
- req := &gin.H{"amount": 30} // micro-service payload
- // DtmServer is the address of DTM micro-service
- saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)).
- // add a TransOut subtraction，forward operation with url: qsBusi+"/TransOut", reverse compensation operation with url: qsBusi+"/TransOutCompensate"
- Add(qsBusi+"/TransOut", qsBusi+"/TransOutCompensate", req).
- // add a TransIn subtraction, forward operation with url: qsBusi+"/TransIn", reverse compensation operation with url: qsBusi+"/TransInCompensate"
- Add(qsBusi+"/TransIn", qsBusi+"/TransInCompensate", req)
- // submit the created saga transaction，dtm ensures all subtractions either complete or get revoked
- err := saga.Submit()
+ saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)).
+ // 添加一个TransOut的子事务，正向操作为url: qsBusi+"/TransOut"， 补偿操作为url: qsBusi+"/TransOutCompensate"
+ Add(qsBusi+"/TransOut", qsBusi+"/TransOutCompensate", req).
+ // 添加一个TransIn的子事务，正向操作为url: qsBusi+"/TransIn"， 补偿操作为url: qsBusi+"/TransInCompensate"
+ Add(qsBusi+"/TransIn", qsBusi+"/TransInCompensate", req)
+ // 提交saga事务，dtm会完成所有的子事务/回滚所有的子事务
+ err := saga.Submit()
```
-### Complete example
-Refer to [examples/quick_start.go](./examples/quick_start.go).
+成功运行后，可以看到TransOut、TransIn依次被调用，完成了整个分布式事务
-### Slack
+### 时序图
-You can join the [DTM slack channel here](https://join.slack.com/t/dtm-w6k9662/shared_invite/zt-vkrph4k1-eFqEFnMkbmlXqfUo5GWHWw).
+上述saga分布式事务的时序图如下：
-### Wechat
+
-Add wechat friend with id yedf2008, or scan the OR code. Fill in dtm as verification.
+### 完整示例
+参考[examples/quick_start.go](./examples/quick_start.go)
+
+## 交流群
+请加 yedf2008 好友或者扫码加好友，验证回复 dtm 按照指引进群
-### Give a star! ⭐
+如果您觉得[dtm](https://github.com/yedf/dtm)不错，或者对您有帮助，请赏颗星吧！
-If you think this project is good, or helpful to you, please give a star!
-
-### Who is using
+## 谁在使用
- 
- 
- 
-