未验证 提交 7f5fbf42 编写于 作者: V vickyYe 提交者: GitHub

feat: Readme中英文修改 (#525)

上级 8f51d768
......@@ -3,7 +3,7 @@
<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">京东风格的轻量级移动端 React 组件库,支持一套代码生成 H5 和小程序</p>
<p align="center">JD-style mobile UI components based on React that support users to develop H5 and mini-programs.</p>
<p align="center">
<a href="http://makeapullrequest.com">
......@@ -35,90 +35,100 @@
</p>
---
> Nut[nʌt],源自电影《冰河世纪》里松鼠 Scrat "执迷不悟",一生追求,即便引发大灾难也绝不松手的坚果。
## 特性
> 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***.
* 🚀 60+ 高质量组件, 覆盖移动端主流场景
* 📖 基于京东APP 10.0 视觉规范
* 🍭 支持按需引用
* 📖 详尽的文档和示例
* 💪 支持 TypeScript
* 💪 支持服务端渲染(测试阶段)
* 🍭 支持定制主题
* 🍭 单元测试覆盖率超过80%, 保障稳定性
* 📖 提供 Sketch 设计资源
[简体中文](./README_ZH.md) | English
## 构建版本
## Features
> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版,非模块化环境(如通过 `<script>` 标签直接引用)建议使用 umd 压缩版。
* 🚀 60+ High Quality Components
* 📖 Based on JD APP 10.0 Visual Specifications
* 🍭 Support Tree Shaking
* 📖 Extensive Documentation and Demos
* 💪 Written in TypeScript
* 💪 Support SSR (Experimental)
* 🍭 Support Custom Themes
* 🍭 80%+ Unit Test Coverage
* 📖 Provide Sketch Design Resources
* es **nutui.react.es.js**
## 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**
## 链接
## Links
<ul>
<li>
<a href="https://github.com/jdf2e/nutui-react/discussions">
Discussions (用👍投票)
Discussions (vote with 👍)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">
Feature Requests (用👍投票)
Feature Requests (vote with 👍)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/labels/bug%203.0">
Bugs (用👍投票)
Bugs (vote with 👍)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion">
Question (用👍投票)
Question (vote with 👍)
</a>
</li>
</ul>
## 开发交流
| 版本 | 微信群 |内部咚咚群 |
## Communication
| Version | WeChat Group | JD Dongdong Group |
| --- | --- |--- |
| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> 关注后回复「NutUI-React」 | 1025679314 |
| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> 关注后回复「NutUI-React」 | 1022545110 |
| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> Reply 「NutUI-React」 after following | 1025679314 |
| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" />Reply 「NutUI-React」 after following | 1022545110 |
## 参与共建
#### NutUI 社区共建倡议
## Join Us
[NutUI-React 邀您共建,Contributor 您好](https://github.com/jdf2e/nutui-react/discussions/348)
#### NutUI Community
#### 为 NutUI 贡献代码
[*Welcome To NutUI-React Community*](https://github.com/jdf2e/nutui-react/discussions/348)
NutUI 的共建方向主要分为:解决 issue、修复 bug、新增组件、增加国际化、UI 定制、平台适配、跨端扩展等。
#### Contribute to NutUI
欢迎社区开发者参与共建,在贡献您的代码之前请先阅读 [《NutUI 贡献指南》](https://github.com/jdf2e/nutui-react/discussions/348)
There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.
## 问题反馈与建议
You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui-react/discussions/348)
[给 NutUI 提 Issue](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
> 在反馈问题之前,推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)和[《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html),这样您能够更容易获得理解和帮助。
## Issue & Discussion
[参与 NutUI 社区讨论](https://github.com/jdf2e/nutui-react/discussions)
[Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
如果您有任何想法、疑问或建议,都可以参与社区讨论分享您的观点。
> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
## 贡献者们
[NutUI Discussion](https://github.com/jdf2e/nutui-react/discussions)
If you have any ideas, questions or suggestions, you can share your opinions here.
## Contributors
Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/graphs/contributors)。 who have contributed code to NutUI.
感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui-react/graphs/contributors)
<a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
<img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" />
<img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" alt="contributors"/>
</a>
## Stargazers
[![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)
......@@ -127,14 +137,15 @@ NutUI 的共建方向主要分为:解决 issue、修复 bug、新增组件、
[![Forkers repo roster for @jdf2e/nutui-react](https://reporoster.com/forks/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/network/members)
## 开发计划
## Milestones
[Milestones](https://github.com/jdf2e/nutui-react/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-react/releases)
本项目遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153),更新日志请查阅 [Release](https://github.com/jdf2e/nutui-react/releases)
## 开源协议
## Open Source License
本项目基于 **MIT** 协议
This project is based on **MIT** protocol
\ No newline at end of file
......@@ -3,7 +3,7 @@
<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 React that support users to develop H5 and mini-programs.</p>
<p align="center">京东风格的轻量级移动端 React 组件库,支持一套代码生成 H5 和小程序</p>
<p align="center">
<a href="http://makeapullrequest.com">
......@@ -35,100 +35,92 @@
</p>
---
> Nut[nʌt],源自电影《冰河世纪》里松鼠 Scrat "执迷不悟",一生追求,即便引发大灾难也绝不松手的坚果。
> 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***.
简体中文 | [English](./README.md)
[简体中文](./README.md) | English
## 特性
## Features
* 🚀 60+ 高质量组件, 覆盖移动端主流场景
* 📖 基于京东APP 10.0 视觉规范
* 🍭 支持按需引用
* 📖 详尽的文档和示例
* 💪 支持 TypeScript
* 💪 支持服务端渲染(测试阶段)
* 🍭 支持定制主题
* 🍭 单元测试覆盖率超过80%, 保障稳定性
* 📖 提供 Sketch 设计资源
* 🚀 60+ High Quality Components
* 📖 Based on JD APP 10.0 Visual Specifications
* 🍭 Support Tree Shaking
* 📖 Extensive Documentation and Demos
* 💪 Written in TypeScript
* 💪 Support SSR (Experimental)
* 🍭 Support Custom Themes
* 🍭 80%+ Unit Test Coverage
* 📖 Provide Sketch Design Resources
## 构建版本
> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版,非模块化环境(如通过 `<script>` 标签直接引用)建议使用 umd 压缩版。
## 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**
* es **nutui.react.es.js**
* umd **nutui.umd.js**
## Links
## 链接
<ul>
<li>
<a href="https://github.com/jdf2e/nutui-react/discussions">
Discussions (vote with 👍)
Discussions (用👍投票)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">
Feature Requests (vote with 👍)
Feature Requests (用👍投票)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/labels/bug%203.0">
Bugs (vote with 👍)
Bugs (用👍投票)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion">
Question (vote with 👍)
Question (用👍投票)
</a>
</li>
</ul>
## Communication
| Version | WeChat Group | JD Dongdong Group |
## 开发交流
| 版本 | 微信群 |内部咚咚群 |
| --- | --- |--- |
| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> Reply 「NutUI-React」 after following | 1025679314 |
| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" />Reply 「NutUI-React」 after following | 1022545110 |
| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> 关注后回复「NutUI-React」 | 1025679314 |
| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> 关注后回复「NutUI-React」 | 1022545110 |
## Join Us
## 参与共建
#### NutUI Community
#### NutUI 社区共建倡议
[*Welcome To NutUI-React Community*](https://github.com/jdf2e/nutui-react/discussions/348)
[NutUI-React 邀您共建,Contributor 您好](https://github.com/jdf2e/nutui-react/discussions/348)
#### Contribute to NutUI
#### 为 NutUI 贡献代码
There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.
NutUI 的共建方向主要分为:解决 issue、修复 bug、新增组件、增加国际化、UI 定制、平台适配、跨端扩展等。
You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui-react/discussions/348)
欢迎社区开发者参与共建,在贡献您的代码之前请先阅读 [《NutUI 贡献指南》](https://github.com/jdf2e/nutui-react/discussions/348)
## 问题反馈与建议
## Issue & Discussion
[给 NutUI 提 Issue](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
[Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
> 在反馈问题之前,推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)和[《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html),这样您能够更容易获得理解和帮助。
> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
[参与 NutUI 社区讨论](https://github.com/jdf2e/nutui-react/discussions)
[NutUI Discussion](https://github.com/jdf2e/nutui-react/discussions)
如果您有任何想法、疑问或建议,都可以参与社区讨论分享您的观点。
If you have any ideas, questions or suggestions, you can share your opinions here.
## Contributors
Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/graphs/contributors)。 who have contributed code to NutUI.
## 贡献者们
感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui-react/graphs/contributors)
<a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
<img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" alt="contributors"/>
<img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" />
</a>
## Stargazers
[![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)
......@@ -137,15 +129,14 @@ Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/gr
[![Forkers repo roster for @jdf2e/nutui-react](https://reporoster.com/forks/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/network/members)
## Milestones
## 开发计划
[Milestones](https://github.com/jdf2e/nutui-react/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-react/releases)
## 更新日志
本项目遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153),更新日志请查阅 [Release](https://github.com/jdf2e/nutui-react/releases)
## Open Source License
## 开源协议
This project is based on **MIT** protocol
\ No newline at end of file
本项目基于 **MIT** 协议
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册