GS-315:文档-升级readme、打包

FE-Driver · May 16, 2017 · 94dc773 · 94dc773
1 parent 998488f
commit 94dc773
Show file tree

Hide file tree

Showing 6 changed files with 447 additions and 600 deletions.
diff --git a/README.md b/README.md
@@ -1,61 +1,54 @@
-# vue-beauty
+<p align="center">
+    <a href="https://github.com/FE-Driver/vue-beauty">
+        <img width="200" src="https://raw.githubusercontent.com/FE-Driver/vue-beauty/master/src/assets/VB-logo.png">
+    </a>
+</p>
+
+# vue-beauty [![npm](http://img.shields.io/npm/v/vue-beauty.svg)](https://www.npmjs.com/package/vue-beauty) [![NPM downloads](http://img.shields.io/npm/dm/vue-beauty.svg)](https://www.npmjs.com/package/vue-beauty) [![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://www.npmjs.com/package/vue-beauty)
 Beautiful  UI components build with vue and ant design
 
-- [Vue官网](http://vuejs.org/)
-- [Ant.Design官网](http://ant.design/)
-- 本项目采用vue2和ant deisgn2.0进行开发
-
-## 如何体验（How to experience）
-Still developing,not suggesting to use in production!
-- clone本项目，并切换到next分支
-- 安装依赖(yarn)，并打包(npm run package)
-- 在你的项目中引入
-````javascript
-import 'relativePath/vue-beauty/package/style/vue-beauty.min.css';
-import vueBeauty from 'relativePath/vue-beauty';
-
-vue.use(vueBeauty);
-````
-
-## 目录结构
-<pre>
-    VUE-BEAUTY/
-    |-- build               存放webpack的配置
-    |-- vb                  组件库
-    |   |-- components      组件
-    |   |-- directives      指令
-    |   |-- locale          多语言
-    |   |-- mixins          混合
-    |   |-- style           核心样式
-    |   |-- utils           工具方法
-    |   `-- index.js        入口
-    `-- src                 存放文档
-        |-- views           视图页面
-        |-- docs            组件文档
-        |-- components      业务组件
-        |-- main.js         入口
-        `-- routers.js      路由
-</pre>
-
-## 参与流程
-
-- 我们会通过issue的形式发布一系列任务
-- 在任务issue下面回复并认领
-- 根据某个issue，fork并在next分支下实现
-- 提交pr到next分支
-- 合并pr，测试并发布到master分支
-- NOTICE：可以加入QQ群548062121讨论
-
-## 开发步骤
-- 到[ant-design2.0](https://github.com/ant-design/ant-design/tree/master/components)官网拷贝相应的样式到对应组件的style文件夹下，并在组件vue文件里面引入
-- 开发完组件后，需要在vb/components/index.js里面导出
-- 到src/docs下编写组件的使用文档
-- 同时在下列文件：src/routers.js、src/views/components.vue，添加组件的路由和链接
-
-## 命名规范
-- 文件，目录均以横线连接(如data-table)
-- 组件的name均以大写开头，驼峰式(如TreeSelect)
-
-## 感谢
-- 感谢为这个项目做过贡献的所有朋友。
-- 感谢vue和ant design的开发者。
+## 特性
+- 丰富的组件，涵盖常用场景
+- 基于vue组件化开发，数据驱动视图
+- 封装复杂性，提供简单友好的api
+- 基于ant design样式优化
+
+## 引入
+使用npm或者yarn
+```
+npm install vue-beauty -S  OR  yarn add vue-beauty
+
+import Vue from 'vue'
+//import css
+import 'vue-beauty/package/style/vue-beauty.min.css'
+
+//import components
+import vueBeauty from 'vue-beauty'
+Vue.use(vueBeauty)
+
+//OR
+import {alert} from 'vue-beauty'
+Vue.use(alert)
+```
+或使用 &lt;script&gt; 全局引用
+```
+<link rel="stylesheet" href="vue-beauty.min.css"> 
+<script type="text/javascript" src="vue-beauty.min.js"></script> 
+```
+更多说明，请查看我们的[在线文档](https://fe-driver.github.io/vue-beauty)。
+
+## 浏览器支持
+chrome、firefox、暂不支持IE(计划支持IE11+)。
+
+## Polyfill
+本组件库内置了一些es最新实例方法的垫片，请查看[Polyfill](https://fe-driver.github.io/vue-beauty/#!/components/polyfill)。
+
+## 更新日志
+欢迎查看详细的[更新日志](https://github.com/FE-Driver/vue-beauty/releases)。
+
+## 参与贡献
+我们欢迎任何形式的贡献，请阅读[贡献指南](https://fe-driver.github.io/vue-beauty/#!/components/contribute)了解详细的情况。
+
+## 链接
+- [Vue官网](http://cn.vuejs.org//)
+- [Ant.Design官网](http://ant.design/)
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vue-beauty",
-  "version": "2.0.0-alpha4",
+  "version": "2.0.0-beta.1",
   "description": "Ant Design components built with Vue.js",
   "author": "G7:FE-driver",
   "main": "package/vue-beauty.min.js",

diff --git a/package/style/vue-beauty.css b/package/style/vue-beauty.css
@@ -2570,7 +2570,7 @@
   visibility: hidden;
 }
 .ant-pagination-total-text {
-  float: left;
+  display: inline-block;
   height: 30px;
   line-height: 30px;
   margin-right: 10px;
@@ -2584,15 +2584,15 @@
   line-height: 28px;
   text-align: center;
   list-style: none;
-  float: left;
+  display: inline-block;
   border: 1px solid #d9d9d9;
   background-color: #fff;
   margin-right: 8px;
   font-family: Arial;
 }
 .ant-pagination-item a {
   text-decoration: none;
-  color: #666;
+  color: rgba(0, 0, 0, 0.65);
   transition: none;
   margin: 0 6px;
 }
@@ -2616,7 +2616,7 @@
   content: "\2022\2022\2022";
   display: block;
   letter-spacing: 2px;
-  color: #ccc;
+  color: rgba(0, 0, 0, 0.25);
   text-align: center;
 }
 .ant-pagination-jump-prev:hover:after,
@@ -2657,13 +2657,12 @@
 .ant-pagination-jump-next {
   font-family: Arial;
   cursor: pointer;
-  color: #666;
+  color: rgba(0, 0, 0, 0.65);
   border-radius: 4px;
   list-style: none;
   min-width: 28px;
   height: 28px;
   line-height: 28px;
-  float: left;
   text-align: center;
   transition: all 0.3s ease;
   display: inline-block;
@@ -2675,7 +2674,7 @@
 }
 .ant-pagination-prev a,
 .ant-pagination-next a {
-  color: #666;
+  color: rgba(0, 0, 0, 0.65);
 }
 .ant-pagination-prev a:after,
 .ant-pagination-next a:after {
@@ -2688,7 +2687,7 @@
   zoom: 1;
   display: block;
   height: 26px;
-  line-height: 26px;
+  line-height: 27px;
   font-family: "anticon";
   text-align: center;
 }
@@ -2709,7 +2708,6 @@
   color: #108ee9;
 }
 .ant-pagination-prev a:after {
-  margin-top: -0.5px;
   content: "\E620";
   display: block;
 }
@@ -2724,25 +2722,25 @@
   border-color: #d9d9d9;
 }
 .ant-pagination-disabled:hover a {
-  color: #ccc;
+  color: rgba(0, 0, 0, 0.25);
   cursor: not-allowed;
 }
 .ant-pagination-disabled a {
-  color: #ccc;
+  color: rgba(0, 0, 0, 0.25);
 }
 .ant-pagination-slash {
   margin: 0 10px 0 5px;
 }
 .ant-pagination-options {
-  float: left;
+  display: inline-block;
   margin-left: 15px;
 }
 .ant-pagination-options-size-changer {
-  float: left;
+  display: inline-block;
   margin-right: 10px;
 }
 .ant-pagination-options-quick-jumper {
-  float: left;
+  display: inline-block;
   height: 28px;
   line-height: 28px;
 }
@@ -2813,7 +2811,7 @@ textarea.ant-pagination-options-quick-jumper input {
   font-size: 18px;
 }
 .ant-pagination-simple .ant-pagination-simple-pager {
-  float: left;
+  display: inline-block;
   margin-right: 8px;
 }
 .ant-pagination-simple .ant-pagination-simple-pager input {
@@ -2873,6 +2871,12 @@ textarea.ant-pagination-options-quick-jumper input {
   height: 22px;
   width: 44px;
 }
+@media only screen and (max-width: 1024px) {
+  .ant-pagination-item-after-jump-prev,
+  .ant-pagination-item-before-jump-next {
+    display: none;
+  }
+}
 @font-face {
   font-family: "Helvetica Neue For Number";
   src: local("Helvetica Neue");
@@ -13849,9 +13853,9 @@ samp {
 }
 @font-face {
   font-family: 'anticon';
-  src: url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.eot');
+  src: url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.eot');
   /* IE9*/
-  src: url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.eot?#iefix') format('embedded-opentype'), /* chrome、firefox */ url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.woff') format('woff'), /* chrome、firefox、opera、Safari, Android, iOS 4.2+*/ url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.ttf') format('truetype'), /* iOS 4.1- */ url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.svg#iconfont') format('svg');
+  src: url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.eot?#iefix') format('embedded-opentype'), /* chrome、firefox */ url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.woff') format('woff'), /* chrome、firefox、opera、Safari, Android, iOS 4.2+*/ url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.ttf') format('truetype'), /* iOS 4.1- */ url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.svg#iconfont') format('svg');
 }
 .anticon {
   display: inline-block;
@@ -14686,6 +14690,9 @@ samp {
 .anticon-shake:before {
   content: "\E94F";
 }
+.anticon-fork:before {
+  content: "\E6F2";
+}
 .anticon-spin:before {
   display: inline-block;
   animation: loadingCircle 1s infinite linear;
@@ -18640,9 +18647,9 @@ samp {
 }
 @font-face {
   font-family: 'anticon';
-  src: url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.eot');
+  src: url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.eot');
   /* IE9*/
-  src: url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.eot?#iefix') format('embedded-opentype'), /* chrome、firefox */ url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.woff') format('woff'), /* chrome、firefox、opera、Safari, Android, iOS 4.2+*/ url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.ttf') format('truetype'), /* iOS 4.1- */ url('https://at.alicdn.com/t/font_0qcp222wvwijm7vi.svg#iconfont') format('svg');
+  src: url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.eot?#iefix') format('embedded-opentype'), /* chrome、firefox */ url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.woff') format('woff'), /* chrome、firefox、opera、Safari, Android, iOS 4.2+*/ url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.ttf') format('truetype'), /* iOS 4.1- */ url('https://at.alicdn.com/t/font_zck90zmlh7hf47vi.svg#iconfont') format('svg');
 }
 .anticon {
   display: inline-block;
@@ -19477,6 +19484,9 @@ samp {
 .anticon-shake:before {
   content: "\E94F";
 }
+.anticon-fork:before {
+  content: "\E6F2";
+}
 .anticon-spin:before {
   display: inline-block;
   animation: loadingCircle 1s infinite linear;