Skip to content

Commit

Permalink
Merge pull request iview#2185 from md678685/patch-1
Browse files Browse the repository at this point in the history
Fix some English grammar in README
  • Loading branch information
icarusion committed Oct 25, 2017
2 parents 2be2b97 + 692be62 commit 8711920
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions README.md
Expand Up @@ -13,11 +13,11 @@
![CSS gzip size](http://img.badgesize.io/https://unpkg.com/iview/dist/styles/iview.css?compression=gzip&label=gzip%20size:%20CSS&style=flat-square)
[![Join the chat at https://gitter.im/iview/iview](https://img.shields.io/badge/chat-on_gitter-30b392.svg?style=flat-square)](https://gitter.im/iview/iview?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

### A high quality UI Toolkit built on Vue.js.
### A high quality UI Toolkit built on Vue.js.

> This branch is for Vue.js 2.x
> This branch is for Vue.js 2.x.
>
> [HERE](https://github.com/iview/iview/tree/master) is for Vue.js 1.x
> The branch for Vue.js 1.x can be found [here](https://github.com/iview/iview/tree/master).
## Docs

Expand All @@ -32,31 +32,32 @@
## Features

- 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 any skill level.
- Extensive documentation and demos.
- It is quite beautiful.
- Supports Vue.js 2 and Vue.js 1.
- Supports both Vue.js 2 and Vue.js 1.

## Install

> Please install Webpack first
> 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 create your 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

using npm
Using npm:
```
npm install iview --save
```
Or using script tag for global use

Using a script tag for global use:

```html
<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)
You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).

## Usage

Expand All @@ -83,20 +84,20 @@ import 'iview/dist/styles/iview.css';

## Compatibility

- Support Vue.js 2.x
- Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/)
- Support SSR
- Support [Nuxt.js](https://nuxtjs.org/)
- [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.
- Supports Vue.js 2.x
- Supports Vue.js 1.x - [visit 1.0 docs](http://v1.iviewui.com/)
- Supports SSR
- Supports [Nuxt.js](https://nuxtjs.org/)
- Supports [Electron](http://electron.atom.io/)
- iView does not support IE8 or below since [Vue.js](https://vuejs.org/v2/guide/reactivity.html) uses `Object.defineProperty` to track changes which is not supported by these browsers.

## Community

If you want to contribute, have questions or bugs to report:
If you want to contribute or 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!
**Questions:** Find other users at the [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) - please provide a example so we can help you better
**Contribute:** Contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `admin@aresn.com`. PRs welcome!

## Major Contributors
|Name|Avatar|Name|Avatar|Name|Avatar|
Expand Down

0 comments on commit 8711920

Please sign in to comment.