Commit 1d5e9fc339325464aff477e82b774ee55900044a
1 parent
a65aef1a
README updates
Showing
1 changed file
with
23 additions
and
11 deletions
Show diff stats
README.md
| @@ -4,8 +4,8 @@ | @@ -4,8 +4,8 @@ | ||
| 4 | </a> | 4 | </a> |
| 5 | </p> | 5 | </p> |
| 6 | 6 | ||
| 7 | -# iView | ||
| 8 | -[](https://travis-ci.org/iview/iview) | 7 | +# iView |
| 8 | +[](https://travis-ci.org/iview/iview) | ||
| 9 | [](https://www.npmjs.org/package/iview) | 9 | [](https://www.npmjs.org/package/iview) |
| 10 | [](https://npmjs.org/package/iview) | 10 | [](https://npmjs.org/package/iview) |
| 11 | [](https://npmjs.org/package/iview) | 11 | [](https://npmjs.org/package/iview) |
| @@ -23,7 +23,7 @@ | @@ -23,7 +23,7 @@ | ||
| 23 | 23 | ||
| 24 | ### [English (2.0)](https://www.iviewui.com) | 24 | ### [English (2.0)](https://www.iviewui.com) |
| 25 | ### [中文文档 (2.0)](https://www.iviewui.com) | 25 | ### [中文文档 (2.0)](https://www.iviewui.com) |
| 26 | -### [中文文档 (1.0)](http://v1.iviewui.com) | 26 | +[中文文档 (1.0)](http://v1.iviewui.com) |
| 27 | 27 | ||
| 28 | ## Overview | 28 | ## Overview |
| 29 | 29 | ||
| @@ -33,16 +33,15 @@ | @@ -33,16 +33,15 @@ | ||
| 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 all skill levels. |
| 36 | -- Extensive documentation. | 36 | +- Extensive documentation and demos. |
| 37 | - It is quite beautiful. | 37 | - It is quite beautiful. |
| 38 | -- Support Vue.js 2 and Vue.js 1. | 38 | +- Supports Vue.js 2 and Vue.js 1. |
| 39 | 39 | ||
| 40 | ## Install | 40 | ## Install |
| 41 | 41 | ||
| 42 | -### Install webpack project in the first place | ||
| 43 | -We recommend you install project through [iView Cli](https://github.com/iview/iview-cli) Or [iview-project](https://github.com/iview/iview-project). | 42 | +> Please install Webpack first |
| 44 | 43 | ||
| 45 | -You can also use [vue-cli](https://github.com/vuejs/vue-cli). | 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). |
| 46 | 45 | ||
| 47 | ### Install iView | 46 | ### Install iView |
| 48 | 47 | ||
| @@ -51,10 +50,14 @@ using npm | @@ -51,10 +50,14 @@ using npm | ||
| 51 | npm install iview --save | 50 | npm install iview --save |
| 52 | ``` | 51 | ``` |
| 53 | Or using script tag for global use | 52 | Or using script tag for global use |
| 53 | + | ||
| 54 | ```html | 54 | ```html |
| 55 | <script type="text/javascript" src="iview.min.js"></script> | 55 | <script type="text/javascript" src="iview.min.js"></script> |
| 56 | +<link rel="stylesheet" href="dist/styles/iview.css"> | ||
| 56 | ``` | 57 | ``` |
| 57 | 58 | ||
| 59 | +More info [in the website](https://www.iviewui.com/docs/guide/install-en) | ||
| 60 | + | ||
| 58 | ## Usage | 61 | ## Usage |
| 59 | 62 | ||
| 60 | ```html | 63 | ```html |
| @@ -71,7 +74,9 @@ Or using script tag for global use | @@ -71,7 +74,9 @@ Or using script tag for global use | ||
| 71 | } | 74 | } |
| 72 | </script> | 75 | </script> |
| 73 | ``` | 76 | ``` |
| 74 | -Use css | 77 | + |
| 78 | +Using css via `import`: | ||
| 79 | + | ||
| 75 | ```js | 80 | ```js |
| 76 | import 'iview/dist/styles/iview.css'; | 81 | import 'iview/dist/styles/iview.css'; |
| 77 | ``` | 82 | ``` |
| @@ -81,10 +86,17 @@ import 'iview/dist/styles/iview.css'; | @@ -81,10 +86,17 @@ import 'iview/dist/styles/iview.css'; | ||
| 81 | - Support Vue.js 2.x | 86 | - Support Vue.js 2.x |
| 82 | - Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/) | 87 | - Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/) |
| 83 | - Support SSR | 88 | - Support SSR |
| 84 | -- Support Nuxt.js | 89 | +- Support [Nuxt.js](https://nuxtjs.org/) |
| 85 | - [Electron](http://electron.atom.io/) | 90 | - [Electron](http://electron.atom.io/) |
| 86 | - 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. | 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 | 92 | ||
| 93 | +## Community | ||
| 94 | + | ||
| 95 | +If you want to contribute, have questions or bugs to report: | ||
| 96 | + | ||
| 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! | ||
| 88 | 100 | ||
| 89 | ## Major Contributors | 101 | ## Major Contributors |
| 90 | |Name|Avatar|Name|Avatar|Name|Avatar| | 102 | |Name|Avatar|Name|Avatar|Name|Avatar| |
| @@ -99,7 +111,7 @@ import 'iview/dist/styles/iview.css'; | @@ -99,7 +111,7 @@ import 'iview/dist/styles/iview.css'; | ||
| 99 | - [TalkingData](https://github.com/TalkingData) | 111 | - [TalkingData](https://github.com/TalkingData) |
| 100 | - [Vue](https://github.com/vuejs/vue) | 112 | - [Vue](https://github.com/vuejs/vue) |
| 101 | - [Webpack](https://github.com/webpack/webpack) | 113 | - [Webpack](https://github.com/webpack/webpack) |
| 102 | -- [ionicons](https://github.com/driftyco/ionicons) | 114 | +- [Ionicons](https://github.com/driftyco/ionicons) |
| 103 | - [Ant Design](https://github.com/ant-design/ant-design) | 115 | - [Ant Design](https://github.com/ant-design/ant-design) |
| 104 | 116 | ||
| 105 | ## License | 117 | ## License |