From 1d5e9fc339325464aff477e82b774ee55900044a Mon Sep 17 00:00:00 2001 From: Sergio Crisostomo Date: Wed, 27 Sep 2017 17:42:51 +0200 Subject: [PATCH] README updates --- README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2413abb..8f61d8d 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@

-# iView -[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview) +# iView +[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview) [![iView](https://img.shields.io/npm/v/iview.svg?style=flat-square)](https://www.npmjs.org/package/iview) [![NPM downloads](http://img.shields.io/npm/dm/iview.svg?style=flat-square)](https://npmjs.org/package/iview) [![NPM downloads](https://img.shields.io/npm/dt/iview.svg?style=flat-square)](https://npmjs.org/package/iview) @@ -23,7 +23,7 @@ ### [English (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 @@ -33,16 +33,15 @@ - Dozens of useful and beautiful components. - Friendly API. It's made for people with all skill levels. -- Extensive documentation. +- Extensive documentation and demos. - It is quite beautiful. -- Support Vue.js 2 and Vue.js 1. +- Supports Vue.js 2 and Vue.js 1. ## Install -### Install webpack project in the first place -We recommend you install project through [iView Cli](https://github.com/iview/iview-cli) Or [iview-project](https://github.com/iview/iview-project). +> Please install Webpack first -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 @@ -51,10 +50,14 @@ using npm npm install iview --save ``` Or using script tag for global use + ```html + ``` +More info [in the website](https://www.iviewui.com/docs/guide/install-en) + ## Usage ```html @@ -71,7 +74,9 @@ Or using script tag for global use } ``` -Use css + +Using css via `import`: + ```js import 'iview/dist/styles/iview.css'; ``` @@ -81,10 +86,17 @@ import 'iview/dist/styles/iview.css'; - Support Vue.js 2.x - Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/) - Support SSR -- Support Nuxt.js +- 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. +## 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 |Name|Avatar|Name|Avatar|Name|Avatar| @@ -99,7 +111,7 @@ import 'iview/dist/styles/iview.css'; - [TalkingData](https://github.com/TalkingData) - [Vue](https://github.com/vuejs/vue) - [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) ## License -- libgit2 0.21.4