forked from jd-opensource/nutui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add README_EN.md (jd-opensource#1772)
* docs: add README_EN.md * docs: 调整 README_EN.md 字体格式
- Loading branch information
Showing
2 changed files
with
211 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
|
|
||
| <p align="center"> | ||
| <img alt="logo" src="https://img11.360buyimg.com/imagetools/jfs/t1/211965/25/7152/22022/61b16785E433119bb/aa41d7a9f7e823f3.png" width="150" style="margin-bottom: 10px;"> | ||
| </p> | ||
|
|
||
| <p align="center">JD-style mobile UI components based on Vue2 & Vue3 that support users to develop H5 and mini-programs.</p> | ||
|
|
||
| <p align="center"> | ||
| <a href="http://makeapullrequest.com"> | ||
| <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome"> | ||
| </a> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://coveralls.io/repos/github/jdf2e/nutui/badge.svg?branch=master" alt="Coverage Status" /> | ||
| </a> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/npm/l/@nutui/nutui.svg" alt="license"/> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@nutui/nutui"> | ||
| <img src="https://img.shields.io/npm/v/@nutui/nutui.svg?style=flat-square"> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@nutui/nutui"> | ||
| <img src="https://img.shields.io/npm/dt/@nutui/nutui.svg?style=flat-square"> | ||
| </a> | ||
| <a href="https://travis-ci.org/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/travis/jdf2e/nutui.svg?style=flat-square"> | ||
| </a> | ||
|
|
||
| </p> | ||
| <p align="center"> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/github/contributors/jdf2e/nutui" alt="GitHub contributors"> | ||
| </a> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/github/commit-activity/w/jdf2e/nutui" alt="GitHub commit activity"> | ||
| </a> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/github/issues-closed/jdf2e/nutui" alt="GitHub closed issues"> | ||
| </a> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/github/commits-since/jdf2e/nutui/latest/next" alt="GitHub commits since latest release (by date)"> | ||
| </a> | ||
| <a href="https://github.com/jdf2e/nutui"> | ||
| <img src="https://img.shields.io/github/release-date/jdf2e/nutui" alt="GitHub Release Date"> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <img src="https://img12.360buyimg.com/imagetools/jfs/t1/162421/39/13392/9425/6052ea60E592310a9/264bdff23ef5fe95.png" width="164" alt="NutUI" /> | ||
| | ||
| <img src="https://img10.360buyimg.com/imagetools/jfs/t1/211804/23/22232/12144/634e4801Eac435cb6/cfd9e1773cf9423d.png" width="167" title="Scan the QR code with JD APP"> | ||
| | ||
| <img src="https://storage.360buyimg.com/jdc-article/gh_f2231eb941be_258.jpg" width="166" title="Scan the QR code with WeChat"> | ||
| | ||
| <img src="https://img12.360buyimg.com/imagetools/jfs/t1/205124/1/15643/30360/62aad730Ea5734bf9/703bb91a0b73282f.png" width="170" title="Scan the QR code with Alipay"> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| > Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film ***Ice Age***. | ||
| [简体中文](./README.md) | English | ||
|
|
||
| ## Features | ||
|
|
||
| * 🚀 70+ High Quality Components | ||
| * 💪 Write Once, Multi-End Use | ||
| * 📖 Based on JD APP 10.0 Visual Specifications | ||
| * 🍭 Support Tree Shaking | ||
| * 📖 Extensive Documentation and Demos | ||
| * 💪 Written in TypeScript | ||
| * 💪 Support SSR (Experimental) | ||
| * 🍭 Support Custom Themes with 700+ Style Variables | ||
| * 🌍 Support i18n | ||
| * 🍭 80%+ Unit Test Coverage | ||
| * 📖 Provide Sketch Design Resources | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| // Vue2 | ||
| npm i @nutui/nutui@2 | ||
| ``` | ||
|
|
||
| ```bash | ||
| // Vue3 H5 | ||
| npm i @nutui/nutui | ||
| ``` | ||
|
|
||
| ```bash | ||
| // Vue3 Mini Programs | ||
| npm i @nutui/nutui-taro | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```js | ||
| import { createApp } from "vue"; | ||
| import App from "./App.vue"; | ||
|
|
||
| // Note: It will import all components in this way. | ||
| import NutUI from "@nutui/nutui"; | ||
| // Delete the global style import if you customize for tree shaking. | ||
| import "@nutui/nutui/dist/style.css"; | ||
|
|
||
| createApp(App).use(NutUI).mount("#app"); | ||
| ``` | ||
|
|
||
| ## Resources | ||
|
|
||
| [NutUI Quick Start](https://www.bilibili.com/video/BV14r4y1e7LK) | ||
|
|
||
| [Awesome-NutUI](https://github.com/jdf2e/nutui/blob/next/awesome.md) | ||
|
|
||
|
|
||
| ## Themes | ||
|
|
||
| NutUI provides several sets of official themes from actual business inside JD.com. If they don't meet your needs, you can use <a href="https://nutui.jd.com/theme/#/base" target="_blank">Online Theme Editor</a>. | ||
|
|
||
| * <a href="https://nutui.jd.com/#/zh-CN/component/button" target="_blank">JD APP 10.0 Design (Vue3, default)</a> | ||
| * <a href="https://nutui.jd.com/jdt/#/zh-CN/component/button" target="_blank">JDT Design (Vue3)</a> | ||
| * <a href="https://nutui.jd.com/?jdb#/zh-CN/component/button" target="_blank">JD ToB Mall Design (Vue3)</a> | ||
| * <a href="https://nutui.jd.com/?jddkh#" target="_blank">JD Enterprise Business Design (Vue3)</a> | ||
| * <a href="https://nutui.jd.com/jdl/#/cell" target="_blank">JDL Design (Vue2)</a> | ||
|
|
||
|
|
||
| ## Version Intros | ||
|
|
||
| > `@nutui/nutui` and `@nutui/nutui-taro` are parallel versions with some differences. The version numbers are always the same. If you need compatibility with versions below iOS 10, please use `@nutui/nutui@2` . | ||
| * `NutUI 2x` and `NutUI-JDL` are built with Vue2 which support modern browsers, Android >= 4.0, iOS >= 8.0 and only for H5. | ||
| * `NutUI 3x` is built with Vue3 which supports modern browsers, Chrome >= 51 and iOS >= 10.0. You can use it to develop both H5 and mini-programs. | ||
|
|
||
| ## Build Versions | ||
|
|
||
| > If you are using AMD environment or build tools such as Webpack, Vite, etc., we recommend using the `es` version. If it is a non-module environment (such as direct reference through the `<script>` tag), it is recommended to use the `umd` compressed version. | ||
| * es **nutui.es.js** | ||
|
|
||
| * umd **nutui.umd.js** | ||
|
|
||
|
|
||
| ## Cases | ||
|
|
||
| NutUI has been used in our production environment, and widely used in the industry for cross-platform development. | ||
| <p> | ||
| <img src="http://storage.360buyimg.com/jdc-article/nutuiDemo/user-cases.jpg" alt="NutUI" /> | ||
| </p> | ||
| <p><a href="https://nutui.jd.com/#/case">View more cases</a></p> | ||
| <p>We are collecting more excellent cases, please click <a href="https://get.jd.com/#/survey/index?id=4217247740034539"> here </a> to submit.</p> | ||
|
|
||
| ## Links | ||
|
|
||
| <ul> | ||
| <li> | ||
| <a href="https://github.com/jdf2e/nutui/discussions"> | ||
| Discussions (vote with 👍) | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/jdf2e/nutui/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22"> | ||
| Feature Requests (vote with 👍) | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/jdf2e/nutui/labels/bug%203.0"> | ||
| Bugs (vote with 👍) | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/jdf2e/nutui/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion"> | ||
| Question (vote with 👍) | ||
| </a> | ||
| </li> | ||
| </ul> | ||
|
|
||
| ## Communication | ||
|
|
||
| | Version | WeChat Group | JD Dongdong Group | | ||
| | --- | --- |--- | | ||
| | [NutUI Vue](https://github.com/jdf2e/nutui/issues) | <img src="https://storage.360buyimg.com/nutui-static/image/wx-code.png" width="100" /> Reply 'NutUI' after following | 82957939 | ||
| | [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> Reply 'NutUI' after following | 1022545110 | | ||
|
|
||
|
|
||
| ## Join Us | ||
|
|
||
| Please read [*Developer Contributing Guide*](https://nutui.jd.com/#/en-US/guide/contributing) before you create a [Pull Request](https://github.com/jdf2e/nutui/pulls). | ||
|
|
||
| > You are very welcome to contribute code to NutUI. It is highly recommended to read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html), [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) and [*Welcome to NutUI community*](https://jelly.jd.com/article/6320528b92d94a0068685525), then you can get understanding and help more easily. | ||
| ## Contributors | ||
|
|
||
| Thanks to all the following [developers](https://github.com/jdf2e/nutui/graphs/contributors) who have contributed code to NutUI. | ||
|
|
||
| <a href="https://github.com/jdf2e/nutui/graphs/contributors"> | ||
| <img src="https://opencollective.com/nutui/contributors.svg?width=890&button=false" alt="contributors"> | ||
| </a> | ||
|
|
||
| ## Milestones | ||
|
|
||
| [Milestones](https://github.com/jdf2e/nutui/projects) | ||
|
|
||
| ## Release Notes | ||
|
|
||
| NutUI follows [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153). The up-to-date release notes are available on [Release](https://github.com/jdf2e/nutui/releases). | ||
|
|
||
| ## Github Stargazers | ||
|
|
||
|  | ||
|
|