Browse Source

add english readme

杨磊 6 years ago
parent
commit
6a6bb0254e
1 changed files with 60 additions and 0 deletions
  1. 60 0
      README.cn.md

+ 60 - 0
README.cn.md

@@ -0,0 +1,60 @@
+# NutUI 2
+![npm version](https://img.shields.io/npm/v/@nutui/nutui.svg)  [![Build Status](https://api.travis-ci.org/jdf2e/nutui.svg?branch=master)](https://github.com/jdf2e/nutui/) [![Coverage Status](https://coveralls.io/repos/github/jdf2e/nutui/badge.svg?branch=master)](https://coveralls.io/github/jdf2e/nutui?branch=master) ![license](https://img.shields.io/npm/l/@nutui/nutui.svg)
+ 
+A light mobile Toolkit based on Vue
+    
+![NutUI](https://img11.360buyimg.com/uba/jfs/t1/11117/21/3608/18942/5c20ab52E35e5a500/02e3c1f89cd3dad1.png)
+
+
+## Features
+
+* Cross-platform,auto conversion WeChat components(coming soon)
+* New structure
+* Used by 30+ JD mobile projects
+* Refer to JD APP 7.0 visual specification
+* Support on-demand loading
+* Detailed documents and examples
+* Support customize themes
+* Support multiple languages (Internationalization)
+* Support TypeScript
+* Support Vue Server-side Rendering(Vue SSR)
+* Unit test blessing
+* A Webpack-based build tool is available to quickly create a Vue project with this component library built in 
+
+> If you want to use the 1.x version, please specify the version number when installing,such as: `npm i @nutui/nutui@1.3.2 -S`
+
+## Environment Support
+
+* Android 4.0+
+* iOS 8.0+
+* Support Vue Server-side Rendering
+
+## Version
+
+* Stable:[![npm](https://img.shields.io/npm/v/@nutui/nutui.svg)](https://www.npmjs.com/package/@nutui/nutui)
+
+> You can also subscribe to: https://github.com/jdf2e/nutui/releases.atom for the notifications of stable releases。
+
+## Examples
+
+![NutUI Demo](https://img14.360buyimg.com/uba/jfs/t1/32118/11/559/2782/5c3d81ecEbda0c0f1/5f2b637d11817204.png)
+
+## Installation
+
+Please refer to the NutUI offcial website for the details on how to use it 
+
+https://nutui.jd.com
+
+Documents:[2.X](https://nutui.jd.com/default.html#/start) | [1.X](https://nutui.jd.com/1x/index.html#/intro)
+
+## Links
+* [Feedback](https://github.com/jdf2e/nutui/issues)
+* [Change Logs](https://github.com/jdf2e/nutui/releases)
+* [On-demand plugins](https://www.npmjs.com/package/@nutui/babel-plugin-separate-import)
+* [Template project command line tool(Gaea-cli)](https://github.com/jdf2e/Gaea4)
+* Contact us:nutui@jd.com
+
+
+## LGPL
+
+Based on **MIT** LICENSE