From 21f2db081ebfd132c47d81948ccf8262fc638ac4 Mon Sep 17 00:00:00 2001
From: Erindcl <zhifei@dtstack.com>
Date: Tue, 20 Oct 2020 15:38:50 +0800
Subject: [PATCH] feat: modify README and changeLog

---
 README.md                      | 84 +++++++++++-----------------------
 docs/react/change-log.zh-CN.md |  4 +-
 2 files changed, 29 insertions(+), 59 deletions(-)

diff --git a/README.md b/README.md
index 2d227cea..b1a365f0 100755
--- a/README.md
+++ b/README.md
@@ -1,29 +1,31 @@
-# DT Theme
+# ant-design-dtinsight-theme
 
-本项目为数栈 UI4.0 规范样式
+本项目基于 antd 3.x 实现数栈 UI4.0 规范样式的编写，基于 bisheng 框架实现组件样式预览。
 
-## 目录结构
-<br/>
+在本项目你可以：
 
-```bash
+- 查看组件预览及其相关代码实现
+- 自定义样式使用及预览
 
-├── .
-├── .gitignore         // git 忽略
-├── README.md          // 文档说明
-├── bisheng.config.js  // 全局配置文件
-├── components         // 组件功能
-├── dist               // 打包后静态文件输出目录
-├── docs               // markdown 文件
-├── default.conf       // docker nignx 配置文件
-├── package.json       // 项目依赖
-└── theme              // 基于 Ant Desgin 的主题（子目录中的dt-theme为UI4.0定制样式）
+## 安装
 
+```javascript
+npm install ant-design-dtinsight-theme --save
+
+或
+
+yarn add ant-design-dtinsight-theme
 ```
-<br/>
 
-## 项目启动&打包
-<br/>
+## 使用
+
+[如何在数栈应用中使用](./docs/react/getting-started.zh-CN.md)
+
+## 本地开发
 
+[theme 项目开发指南](./docs/react/develop.zh-CN.md)
+
+### 项目启动&打包
 
 - `npm install // 安装项目依赖`
 
@@ -37,50 +39,18 @@
 
 - `npm run build // 打包项目、静态文件生成目录为当前目录的 dist`
 
-<br/>
-
-## Nginx 配置
-<br/>
-
-```bash
-
-server {
-    listen       8989;
-    underscores_in_headers on;
-    charset utf-8;
-    gzip on;
-    gzip_comp_level 9;
-    gzip_min_length 1k;
-    gzip_types text/plain text/css application/x-javascript text/xml application/xml application/xml+rss text/javascript application/json application/javascript;
-    gzip_vary on;
-    gzip_http_version 1.1;
-    gzip_disable "MSIE [1-6]\.(?!.*SV1)";
-    proxy_set_header Host $host;
-    proxy_set_header RealIP $remote_addr;
-    proxy_set_header REMOTE-HOST $remote_addr;
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+### Nginx 配置
 
-    proxy_read_timeout 300;
+[Nginx 配置示例](./default.conf)
 
-    location / {
-      try_files $uri /index.html;
-      location ~ .*\.(ico|js|css|gif|jpg|jpeg|png|bmp|swf)$ {}
-      root /home/app/ant-design-dtinsight-theme/dist;
-      rewrite ^/$ /docs/react/getting-started.html redirect;
-    }
-    error_page  500 502 503 504 404 http://172.16.100.225:8989/docs/react/getting-started.html;
-
-}
-
-
-```
-<br/>
-
-## 注意事项
-<br/>
+### 注意事项
 
 - 模板文件路径 `./theme/static/template.html`
 
 - 首页为空白页，需用 nginx rewrite 至指定页面
 
 - 目前仅支持中文，如需使用其他语言请自行解决
+
+## 变更记录
+
+[更新日志](./docs/react/change-log.zh-CN.md)
diff --git a/docs/react/change-log.zh-CN.md b/docs/react/change-log.zh-CN.md
index 40f84edf..98d085f7 100755
--- a/docs/react/change-log.zh-CN.md
+++ b/docs/react/change-log.zh-CN.md
@@ -5,7 +5,7 @@ toc: false
 timeline: true
 ---
 
-## [1.0.7](http://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/ant-design-dtinsight-theme/tree/v1.0.9) (020-07-31)
+## [1.0.9](http://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/ant-design-dtinsight-theme/tree/v1.0.9) (2020-07-31)
 
 ### Fix
 
@@ -18,7 +18,7 @@ timeline: true
 
 * Layout 添加 自定义图标侧边导航 demo
 
-## [1.0.7](http://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/ant-design-dtinsight-theme/tree/v1.0.7) (020-07-02)
+## [1.0.7](http://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/ant-design-dtinsight-theme/tree/v1.0.7) (2020-07-02)
 
 ### Fix