From f53654e4e47a0dda8a6197ab630a8d070be86386 Mon Sep 17 00:00:00 2001
From: windy <windy@fanruan.com>
Date: Mon, 16 Sep 2019 15:13:38 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20'readme.md'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

修改描述
---
 readme.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index 42e14c9..ec08dbf 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,32 @@
-# BI用户引导
+# BI全局样式自定义插件
 
-该插件用于引导BI新用户使用BI。
\ No newline at end of file
+该插件目前版本提供两个功能：
+* 在仪表盘处可以使用用户自定义的字体
+* 可以在新建组件的时候修改组件的默认配置（当前版本可配置图的网格线与线框粗细）
+
+## 效果示例
+![配置1](http://git.fanruan.com/windy/dashboard-style/src/branch/master/shortcut/config1.png)
+![配置2](http://git.fanruan.com/windy/dashboard-style/src/branch/master/shortcut/config2.png)
+![配置3](http://git.fanruan.com/windy/dashboard-style/src/branch/master/shortcut/config3.png)
+![配置4](http://git.fanruan.com/windy/dashboard-style/src/branch/master/shortcut/config4.png)
+
+## 注意事项
+如果要修改图的字体，需要修改插件中的entry中的代码
+```
+BI.config("bi.provider.template_style", function (p) {
+    p.inject({                      // 通过inject注入想要添加的配置
+        fonts: [{
+            value: "adidasHeader", // **为了改变图的样式，字体的命名应该和系统安装的字体名称一样**
+            text: "自定义字体头字体"
+        }, {
+            value: "adidasBody",
+            text: "自定义字体Bodyzi字体"
+        }],
+        style: {
+            axisWidth: 0,       // 默认轴线粗细
+            hGridWidth: 0,      // 默认横向网格线粗细
+            vGridWidth: 0       // 默认纵向网格线粗细
+        }
+    });
+});
+```
\ No newline at end of file