chenhaodong / mew-iview

Commit 4ef54c6ea94cf1701924892031ed72b83391a3f2

Authored by Aresn
Committed by GitHub
2 parents fa5ea60b 1d5e9fc3

Merge pull request #2010 from SergioCrisostomo/contribute 

README update suggestions
Showing 1 changed file with 23 additions and 11 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @4ef54c6
... ... @@ -4,8 +4,8 @@
4 4 </a>
5 5 </p>
6 6  
7   -# iView
8   -[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
  7 +# iView
  8 +[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
9 9 [![iView](https://img.shields.io/npm/v/iview.svg?style=flat-square)](https://www.npmjs.org/package/iview)
10 10 [![NPM downloads](http://img.shields.io/npm/dm/iview.svg?style=flat-square)](https://npmjs.org/package/iview)
11 11 [![NPM downloads](https://img.shields.io/npm/dt/iview.svg?style=flat-square)](https://npmjs.org/package/iview)
... ... @@ -23,7 +23,7 @@
23 23  
24 24 ### [English (2.0)](https://www.iviewui.com)
25 25 ### [中文文档 (2.0)](https://www.iviewui.com)
26   -### [中文文档 (1.0)](http://v1.iviewui.com)
  26 +[中文文档 (1.0)](http://v1.iviewui.com)
27 27  
28 28 ## Overview
29 29  
... ... @@ -33,16 +33,15 @@
33 33  
34 34 - Dozens of useful and beautiful components.
35 35 - Friendly API. It's made for people with all skill levels.
36   -- Extensive documentation.
  36 +- Extensive documentation and demos.
37 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 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 46 ### Install iView
48 47  
... ... @@ -51,10 +50,14 @@ using npm
51 50 npm install iview --save
52 51 ```
53 52 Or using script tag for global use
  53 +
54 54 ```html
55 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 61 ## Usage
59 62  
60 63 ```html
... ... @@ -71,7 +74,9 @@ Or using script tag for global use
71 74 }
72 75 </script>
73 76 ```
74   -Use css
  77 +
  78 +Using css via `import`:
  79 +
75 80 ```js
76 81 import 'iview/dist/styles/iview.css';
77 82 ```
... ... @@ -81,10 +86,17 @@ import &#39;iview/dist/styles/iview.css&#39;;
81 86 - Support Vue.js 2.x
82 87 - Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/)
83 88 - Support SSR
84   -- Support Nuxt.js
  89 +- Support [Nuxt.js](https://nuxtjs.org/)
85 90 - [Electron](http://electron.atom.io/)
86 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 101 ## Major Contributors
90 102 |Name|Avatar|Name|Avatar|Name|Avatar|
... ... @@ -99,7 +111,7 @@ import &#39;iview/dist/styles/iview.css&#39;;
99 111 - [TalkingData](https://github.com/TalkingData)
100 112 - [Vue](https://github.com/vuejs/vue)
101 113 - [Webpack](https://github.com/webpack/webpack)
102   -- [ionicons](https://github.com/driftyco/ionicons)
  114 +- [Ionicons](https://github.com/driftyco/ionicons)
103 115 - [Ant Design](https://github.com/ant-design/ant-design)
104 116  
105 117 ## License
... ...