From 8ba8d25f98f7c7b28e1b5f505837a18a97667b6c Mon Sep 17 00:00:00 2001
From: yedf2 <120050102@qq.com>
Date: Wed, 13 Jul 2022 20:51:05 +0800
Subject: [PATCH] add client readme

---
 client/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 client/README.md

diff --git a/client/README.md b/client/README.md
new file mode 100644
index 0000000..4ab597e
--- /dev/null
+++ b/client/README.md
@@ -0,0 +1,31 @@
+# Go Client for DTM
+
+There are there packages:
+
+## workflow
+Workflow is a new client for DTM. It support the mixed usage of patterns saga, tcc, xa. And it also support the mixed usage of http, grpc and local transactions.
+
+This pattern offers maximum flexibility and can handle a wide range of scenarios. This pattern is highly recommended for transactions that need to be rolled back
+
+Quick start for workflow using http can be found here: [https://github.com/dtm-labs/quick-start-sample/tree/main/workflow-http](https://github.com/dtm-labs/quick-start-sample/tree/main/workflow-http)
+
+Quick start for workflow using grpc can be found here: [https://github.com/dtm-labs/quick-start-sample/tree/main/workflow-grpc](https://github.com/dtm-labs/quick-start-sample/tree/main/workflow-grpc)
+
+Detailed examples can be found here: [https://github.com/dtm-labs/dtm-examples](https://github.com/dtm-labs/dtm-examples)
+
+
+## dtmcli
+dtmcli is the http client for patterns: saga, tcc, msg, xa
+
+Quick start for dtmcli can be found here: [https://github.com/dtm-labs/quick-start-sample/tree/main/dtmcli-qs](https://github.com/dtm-labs/quick-start-sample/tree/main/dtmcli-qs)
+
+Detailed examples can be found here: [https://github.com/dtm-labs/dtm-examples](https://github.com/dtm-labs/dtm-examples)
+
+## dtmgrpc
+dtmcli is the grpc client for patterns: saga, tcc, msg, xa
+
+Quick start for dtmgrpc can be found here: [https://github.com/dtm-labs/quick-start-sample/tree/main/dtmgrpc-qs](https://github.com/dtm-labs/quick-start-sample/tree/main/dtmgrpc-qs)
+
+Detailed examples can be found here: [https://github.com/dtm-labs/dtm-examples](https://github.com/dtm-labs/dtm-examples)
+
+