From 27f0d89417ea02a3f5e00e7017d44df6382477c7 Mon Sep 17 00:00:00 2001 From: 梁灏 Date: Sat, 24 Sep 2016 22:43:55 +0800 Subject: [PATCH] update readme --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- assets/logo.png | Bin 0 -> 3893 bytes package.json | 2 +- 3 files changed, 73 insertions(+), 3 deletions(-) create mode 100644 assets/logo.png diff --git a/README.md b/README.md index 9cce366..78fe66c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,83 @@ -# iView +

+ + + +

-### A high quality UI components Library with Vue.js +# iView ![iView](https://img.shields.io/npm/v/iview.svg?style=flat-square)(https://www.npmjs.org/package/iview) + +### A high quality UI Components Library with Vue.js ## Docs ### [中文文档](https://www.iviewui.com) +## Overview + +### [组件概览(Component Overview)](https://www.iviewui.com/overview) + +## Features + +- Using .vue file development mode +- Based on npm + webpack + babel, support ES2015 +- High quality and rich functions +- Friendly APIs,free and flexible + ## Programming ![iView](https://raw.githubusercontent.com/iview/iview/master/assets/iview.png) +## Install + +### Install vue-webpack project in the first place + +Use [vue-vueRouter-webpack](https://github.com/icarusion/vue-vueRouter-webpack)(Recommended) Or [vue-cli](https://github.com/vuejs/vue-cli) + +### Install iView + +```bash +npm install iview --save +``` + +### Babel support for iView in webpack +```js +module: { + loaders: [ + { test: /iview\/.*?js$/, loader: 'babel' }, + { test: /\.js$/, loader: 'babel', exclude: /node_modules/ } + ] +} +``` + +## Usage + +Use component as required + +```html + + +``` +Use css +```js +import 'iview/dist/styles/iview.css'; +``` + +## Browser Support + +Normal browsers and Internet Explorer 9+. + +## Links + +- [Vue](https://github.com/vuejs/vue) +- [Webpack](https://github.com/webpack/webpack) +- [ionicons](https://github.com/driftyco/ionicons) +- [Ant Design](https://github.com/ant-design/ant-design) + # We have been in developing, please pay attention to the iView. \ No newline at end of file diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..ff2bf7f Binary files /dev/null and b/assets/logo.png differ diff --git a/package.json b/package.json index dcaa7b7..f0db4cf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "iview", - "version": "0.0.23", + "version": "0.9.0", "title": "iView", "description": "A high quality UI components Library with Vue.js", "homepage": "http://www.iviewui.com", -- libgit2 0.21.4