readme

Author: xlorne

README.md

@@ -2,50 +2,87 @@
 
   "LCN并不生产事务，LCN只是本地事务的搬用工"
 
+## 官方网址
 
-## maven 中心库地址
+[www.txlcn.org](http://www.txlcn.org)
+
+
+## 框架特点
+
+1. 支持各种基于spring的db框架
+2. 兼容SpringCloud、Dubbo
+3. 使用简单，低依赖，代码完全开源
+4. 基于切面的强一致性事务框架
+5. 高可用，模块可以依赖Dubbo或SpringCloud的集群方式做集群化，TxManager也可以做集群化
+6. 支持本地事务和分布式事务共存
+7. 支持事务补偿机制，增加事务补偿决策提醒
+8. 增加插件拓展机制
+
+
+## 原理介绍
+
+[原理介绍](https://github.com/codingapi/tx-lcn/wiki)
+
+
+
+## 目录说明
+
+transaction-dubbo LCN dubbo rpc框架扩展支持
+
+transaction-springcloud LCN springcloud rpc框架扩展支持
+
+tx-client 是LCN核心tx模块端控制框架
+
+tx-manager 是LCN 分布式事务协调器
+
+tx-plugins-db 是LCN 对关系型数据库的插件支持
+
+tx-plugins-nodb 是LCN 对于无数据库模块的插件支持
+
+tx-plugins-redis 是LCN 对于redis模块的插件支持（功能暂未实现）
+
+
+## 使用说明
+
+分布式事务发起方：
 
 ```
 
-<dependency>
-    <groupId>com.codingapi</groupId>
-    <artifactId>tx-client</artifactId>
-    <version>1.0.0</version>
-</dependency>
-
-<dependency>
-    <groupId>com.codingapi</groupId>
-    <artifactId>tx-plugins-nodb</artifactId>
-    <version>1.0.0</version>
-</dependency>
-
-<dependency>
-    <groupId>com.codingapi</groupId>
-    <artifactId>tx-plugins-db</artifactId>
-    <version>1.0.0</version>
-</dependency>
-
-<dependency>
-	<groupId>com.codingapi</groupId>
-	<artifactId>transaction-springcloud</artifactId>
-	<version>1.0.0</version>
-</dependency>
-
-
-<dependency>
-    <groupId>com.codingapi</groupId>
-    <artifactId>transaction-dubbo</artifactId>
-    <version>1.0.0</version>
-</dependency>
+    @Override
+    @TxTransaction
+    @Transactional
+    public boolean hello() {
+        //本地调用
+        testDao.save();
+        //远程调用方
+        boolean res =  test2Service.test();
+        //模拟异常
+        int v = 100/0;
+        return true;
+    }
+    
+    
+```
 
+分布式事务被调用方(test2Service的业务实现类)
 ```
 
-## 原理介绍
+    @Override
+    @Transactional
+    public boolean test() {
+        //本地调用
+        testDao.save();
+        return true;
+    }
+
+```
+
+如上代码执行完成以后两个模块都将回滚事务。
 
-[LCN原理](https://github.com/codingapi/tx-lcn/wiki/LCN原理)
+说明：在使用LCN分布式事务时，只需要将事务的开始方法添加`@TxTransaction`注解即可。详细见demo教程
 
 
-## demo教程
+## demo演示教程
 
 每个demo下有区分为 jdbc/hibernate/mybatis不同框架的版本demo
 
@@ -54,4 +91,4 @@
 [dubbo版本](https://github.com/codingapi/dubbo-lcn-demo)
 
 
-更多资料维护中...
+技术交流群：554855843