README updates
This commit is contained in:
parent
a65aef1a56
commit
1d5e9fc339
1 changed files with 23 additions and 11 deletions
34
README.md
34
README.md
|
@ -4,8 +4,8 @@
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# iView
|
# iView
|
||||||
[](https://travis-ci.org/iview/iview)
|
[](https://travis-ci.org/iview/iview)
|
||||||
[](https://www.npmjs.org/package/iview)
|
[](https://www.npmjs.org/package/iview)
|
||||||
[](https://npmjs.org/package/iview)
|
[](https://npmjs.org/package/iview)
|
||||||
[](https://npmjs.org/package/iview)
|
[](https://npmjs.org/package/iview)
|
||||||
|
@ -23,7 +23,7 @@
|
||||||
|
|
||||||
### [English (2.0)](https://www.iviewui.com)
|
### [English (2.0)](https://www.iviewui.com)
|
||||||
### [中文文档 (2.0)](https://www.iviewui.com)
|
### [中文文档 (2.0)](https://www.iviewui.com)
|
||||||
### [中文文档 (1.0)](http://v1.iviewui.com)
|
[中文文档 (1.0)](http://v1.iviewui.com)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
@ -33,16 +33,15 @@
|
||||||
|
|
||||||
- Dozens of useful and beautiful components.
|
- Dozens of useful and beautiful components.
|
||||||
- Friendly API. It's made for people with all skill levels.
|
- Friendly API. It's made for people with all skill levels.
|
||||||
- Extensive documentation.
|
- Extensive documentation and demos.
|
||||||
- It is quite beautiful.
|
- It is quite beautiful.
|
||||||
- Support Vue.js 2 and Vue.js 1.
|
- Supports Vue.js 2 and Vue.js 1.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
### Install webpack project in the first place
|
> Please install Webpack first
|
||||||
We recommend you install project through [iView Cli](https://github.com/iview/iview-cli) Or [iview-project](https://github.com/iview/iview-project).
|
|
||||||
|
|
||||||
You can also use [vue-cli](https://github.com/vuejs/vue-cli).
|
We recommend you install project through [iView Cli](https://github.com/iview/iview-cli) Or [iview-project](https://github.com/iview/iview-project). You can also use [vue-cli](https://github.com/vuejs/vue-cli).
|
||||||
|
|
||||||
### Install iView
|
### Install iView
|
||||||
|
|
||||||
|
@ -51,10 +50,14 @@ using npm
|
||||||
npm install iview --save
|
npm install iview --save
|
||||||
```
|
```
|
||||||
Or using script tag for global use
|
Or using script tag for global use
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script type="text/javascript" src="iview.min.js"></script>
|
<script type="text/javascript" src="iview.min.js"></script>
|
||||||
|
<link rel="stylesheet" href="dist/styles/iview.css">
|
||||||
```
|
```
|
||||||
|
|
||||||
|
More info [in the website](https://www.iviewui.com/docs/guide/install-en)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```html
|
```html
|
||||||
|
@ -71,7 +74,9 @@ Or using script tag for global use
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
```
|
```
|
||||||
Use css
|
|
||||||
|
Using css via `import`:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import 'iview/dist/styles/iview.css';
|
import 'iview/dist/styles/iview.css';
|
||||||
```
|
```
|
||||||
|
@ -81,10 +86,17 @@ import 'iview/dist/styles/iview.css';
|
||||||
- Support Vue.js 2.x
|
- Support Vue.js 2.x
|
||||||
- Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/)
|
- Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/)
|
||||||
- Support SSR
|
- Support SSR
|
||||||
- Support Nuxt.js
|
- Support [Nuxt.js](https://nuxtjs.org/)
|
||||||
- [Electron](http://electron.atom.io/)
|
- [Electron](http://electron.atom.io/)
|
||||||
- iView does not support IE8 or below since [Vue.js](https://vuejs.org/v2/guide/reactivity.html) is using Object.defineProperty which do not be supported by these browsers to track changes.
|
- iView does not support IE8 or below since [Vue.js](https://vuejs.org/v2/guide/reactivity.html) is using Object.defineProperty which do not be supported by these browsers to track changes.
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
If you want to contribute, have questions or bugs to report:
|
||||||
|
|
||||||
|
**Questions:** you can find other users at [Gitter chat](https://gitter.im/iview/iview) or post on [StackOverflow using `[iview-ui]` tag](https://stackoverflow.com/questions/tagged/iview-ui)
|
||||||
|
**Bugs:** [file a issue here](https://github.com/iview/iview/issues) and please provide a example so we can help you better
|
||||||
|
**Contribute:** welcome to contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `admin@aresn.com`. PRs welcome!
|
||||||
|
|
||||||
## Major Contributors
|
## Major Contributors
|
||||||
|Name|Avatar|Name|Avatar|Name|Avatar|
|
|Name|Avatar|Name|Avatar|Name|Avatar|
|
||||||
|
@ -99,7 +111,7 @@ import 'iview/dist/styles/iview.css';
|
||||||
- [TalkingData](https://github.com/TalkingData)
|
- [TalkingData](https://github.com/TalkingData)
|
||||||
- [Vue](https://github.com/vuejs/vue)
|
- [Vue](https://github.com/vuejs/vue)
|
||||||
- [Webpack](https://github.com/webpack/webpack)
|
- [Webpack](https://github.com/webpack/webpack)
|
||||||
- [ionicons](https://github.com/driftyco/ionicons)
|
- [Ionicons](https://github.com/driftyco/ionicons)
|
||||||
- [Ant Design](https://github.com/ant-design/ant-design)
|
- [Ant Design](https://github.com/ant-design/ant-design)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
Loading…
Add table
Reference in a new issue