Commit 8711920b2ed585e9d84256e3d2b1048ebbab070e
Committed by
GitHub
Merge pull request #2185 from md678685/patch-1
Fix some English grammar in README
Showing
1 changed file
with
21 additions
and
20 deletions
Show diff stats
README.md
@@ -13,11 +13,11 @@ | @@ -13,11 +13,11 @@ | ||
13 | ![CSS gzip size](http://img.badgesize.io/https://unpkg.com/iview/dist/styles/iview.css?compression=gzip&label=gzip%20size:%20CSS&style=flat-square) | 13 | ![CSS gzip size](http://img.badgesize.io/https://unpkg.com/iview/dist/styles/iview.css?compression=gzip&label=gzip%20size:%20CSS&style=flat-square) |
14 | [![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) | 14 | [![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) |
15 | 15 | ||
16 | -### A high quality UI Toolkit built on Vue.js. | 16 | +### A high quality UI Toolkit built on Vue.js. |
17 | 17 | ||
18 | -> This branch is for Vue.js 2.x | 18 | +> This branch is for Vue.js 2.x. |
19 | > | 19 | > |
20 | -> [HERE](https://github.com/iview/iview/tree/master) is for Vue.js 1.x | 20 | +> The branch for Vue.js 1.x can be found [here](https://github.com/iview/iview/tree/master). |
21 | 21 | ||
22 | ## Docs | 22 | ## Docs |
23 | 23 | ||
@@ -32,31 +32,32 @@ | @@ -32,31 +32,32 @@ | ||
32 | ## Features | 32 | ## Features |
33 | 33 | ||
34 | - Dozens of useful and beautiful components. | 34 | - Dozens of useful and beautiful components. |
35 | -- Friendly API. It's made for people with all skill levels. | 35 | +- Friendly API. It's made for people with any skill level. |
36 | - Extensive documentation and demos. | 36 | - Extensive documentation and demos. |
37 | - It is quite beautiful. | 37 | - It is quite beautiful. |
38 | -- Supports Vue.js 2 and Vue.js 1. | 38 | +- Supports both Vue.js 2 and Vue.js 1. |
39 | 39 | ||
40 | ## Install | 40 | ## Install |
41 | 41 | ||
42 | -> Please install Webpack first | 42 | +> Please install Webpack first! |
43 | 43 | ||
44 | -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). | 44 | +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). |
45 | 45 | ||
46 | ### Install iView | 46 | ### Install iView |
47 | 47 | ||
48 | -using npm | 48 | +Using npm: |
49 | ``` | 49 | ``` |
50 | npm install iview --save | 50 | npm install iview --save |
51 | ``` | 51 | ``` |
52 | -Or using script tag for global use | 52 | + |
53 | +Using a script tag for global use: | ||
53 | 54 | ||
54 | ```html | 55 | ```html |
55 | <script type="text/javascript" src="iview.min.js"></script> | 56 | <script type="text/javascript" src="iview.min.js"></script> |
56 | <link rel="stylesheet" href="dist/styles/iview.css"> | 57 | <link rel="stylesheet" href="dist/styles/iview.css"> |
57 | ``` | 58 | ``` |
58 | 59 | ||
59 | -More info [in the website](https://www.iviewui.com/docs/guide/install-en) | 60 | +You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en). |
60 | 61 | ||
61 | ## Usage | 62 | ## Usage |
62 | 63 | ||
@@ -83,20 +84,20 @@ import 'iview/dist/styles/iview.css'; | @@ -83,20 +84,20 @@ import 'iview/dist/styles/iview.css'; | ||
83 | 84 | ||
84 | ## Compatibility | 85 | ## Compatibility |
85 | 86 | ||
86 | -- Support Vue.js 2.x | ||
87 | -- Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/) | ||
88 | -- Support SSR | ||
89 | -- Support [Nuxt.js](https://nuxtjs.org/) | ||
90 | -- [Electron](http://electron.atom.io/) | ||
91 | -- 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. | 87 | +- Supports Vue.js 2.x |
88 | +- Supports Vue.js 1.x - [visit 1.0 docs](http://v1.iviewui.com/) | ||
89 | +- Supports SSR | ||
90 | +- Supports [Nuxt.js](https://nuxtjs.org/) | ||
91 | +- Supports [Electron](http://electron.atom.io/) | ||
92 | +- 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. | ||
92 | 93 | ||
93 | ## Community | 94 | ## Community |
94 | 95 | ||
95 | -If you want to contribute, have questions or bugs to report: | 96 | +If you want to contribute or have questions or bugs to report: |
96 | 97 | ||
97 | -**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) | ||
98 | -**Bugs:** [file a issue here](https://github.com/iview/iview/issues) and please provide a example so we can help you better | ||
99 | -**Contribute:** welcome to contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `admin@aresn.com`. PRs welcome! | 98 | +**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) |
99 | +**Bugs:** [File a issue here](https://github.com/iview/iview/issues) - please provide a example so we can help you better | ||
100 | +**Contribute:** Contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `admin@aresn.com`. PRs welcome! | ||
100 | 101 | ||
101 | ## Major Contributors | 102 | ## Major Contributors |
102 | |Name|Avatar|Name|Avatar|Name|Avatar| | 103 | |Name|Avatar|Name|Avatar|Name|Avatar| |