文档更新

README.md

@@ -1,37 +1,110 @@
 # novel-cloud
 
 #### 介绍
-小说门户网站，提供文学阅读与写作平台。基于Spring Cloud Alibaba 微服务构建，可用于学习和商用。
+基于[小说精品屋-plus](https://www.oschina.net/p/novel-plus)构建的Spring Cloud 微服务小说门户平台，可用于学习和商用。采用了Spring Boot 2 、Spring Cloud Greenwich、 MyBatis3DynamicSql、Redis、Mq、Elasticsearch、Docker等流行技术，集成了Nacos注册中心/配置中心、Spring Cloud Gateway网关、Spring Boot Admin监控中心等基础服务。前端计划使用Vue开发，目前还在 **<u>开发中</u>**，感兴趣的可以提前关注。
+
+#### 演示地址
+
+[点击前往](http://www.java2nb.com/)（前台门户）
 
 #### 软件架构
-软件架构说明
+
+![QQ20200520-215756](./assert/小说网站Springcloud架构设计.png)
 
 
-#### 安装教程
+#### 项目结构
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+```
+novel-cloud
+├── novel-common -- 通用模块，供其他业务微服务模块依赖
+├── novel-gen -- 持久层代码生成器，集成Swagger
+├── novel-gateway -- 基于Spring Cloud Gateway构建的网关服务
+├── novel-monitor -- 基于Spring Boot Admin构建的监控中心
+├── novel-search -- 基于Elastic Search构建的搜索微服务
+├── novel-home -- 门户首页微服务
+├── novel-news -- 新闻中心微服务
+├── novel-user -- 用户中心微服务
+├── novel-author -- 作家中心微服务
+├── novel-book -- 小说微服务
+└── novel-pay -- 支付微服务
+```
 
-#### 使用说明
+#### 技术选型
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+| 技术                 | 说明                                                         
 
-#### 参与贡献
+| -------------------- | ---------------------------
 
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+| SpringBoot           | Spring应用快速开发脚手架     
+
+| SpringCloud          | 微服务架构解决方案 
+
+| Nacos          | 注册中心和配置中心
+
+| SpringCloud Gateway          | 微服务网关
+
+| SpringBoot Admin          | 微服务监控
+
+| MyBatis              | 持久层ORM框架 
+
+| MyBatis Dynamic SQL  | Mybatis动态sql
+
+| PageHelper           | MyBatis分页插件
+
+| MyBatisGenerator     | 持久层代码生成插件
+
+| Seata        | 分布式事务中间件
+
+| Sharding-Jdbc        | 代码层分库分表中间件
+
+| JJWT                 | JWT登录支持  
+
+| Redis                | 分布式缓存                              
+
+| ElasticSearch        | 搜索引擎                
+
+| RabbitMq             | 消息队列
+
+| OSS                  | 阿里云对象存储服务   
+
+| Mysql                | 数据库服务                 
+
+| Redisson             | 实现分布式锁                                       
+
+| Lombok               | 简化对象封装工具  
+
+| Swagger               | API文档生成工具                                                                              
+
+| Docker               | 应用容器引擎   
+
+| ELK               | 分布式日志分析   
+
+| Vue            | 前端开发框架
 
 
-#### 码云特技
 
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
-5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+#### 截图
+
+1. 注册中心截图
+
+![QQ20200520-215756](./assert/QQ20200528-020224.png)
+
+2. 配置中心截图
+
+   ![QQ20200520-215756](./assert/QQ20200528-020357.png)
+
+3. 监控中心截图
+
+   ![QQ20200520-215756](./assert/QQ20200528-020445.png)
+
+   ![QQ20200520-215756](./assert/QQ20200528-020543.png)
+
+   4. 门户网站
+
+      ![QQ20200520-215756](./assert/pc_index.png)
+
+      
+
+#### 项目文档
+
+敬请期待。。。。