update readme

update readme
This commit is contained in:
梁灏 2016-09-24 22:43:55 +08:00
parent 45b672cad9
commit 27f0d89417
3 changed files with 73 additions and 3 deletions

View file

@ -1,13 +1,83 @@
# iView <p align="center">
<a href="https://www.iviewui.com">
<img width="200" src="https://raw.githubusercontent.com/iview/iview/master/assets/logo.png">
</a>
</p>
### 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 ## Docs
### [中文文档](https://www.iviewui.com) ### [中文文档](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 ## Programming
![iView](https://raw.githubusercontent.com/iview/iview/master/assets/iview.png) ![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
<template>
<Page :current="1" :total="100"></Page>
</template>
<script>
import { Page } from 'iview';
export default {
components: { Page }
}
</script>
```
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. # We have been in developing, please pay attention to the iView.

BIN
assets/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

View file

@ -1,6 +1,6 @@
{ {
"name": "iview", "name": "iview",
"version": "0.0.23", "version": "0.9.0",
"title": "iView", "title": "iView",
"description": "A high quality UI components Library with Vue.js", "description": "A high quality UI components Library with Vue.js",
"homepage": "http://www.iviewui.com", "homepage": "http://www.iviewui.com",