提交 e8ea712d 编写于 作者: O oasis-cloud

chore: readme 更新

上级 5b1407c4
<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>
......@@ -6,61 +7,125 @@
<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">
<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-react">
<img src="https://coveralls.io/repos/github/jdf2e/nutui/badge.svg?branch=master" alt="Coverage Status" />
</a>
<a href="https://github.com/jdf2e/nutui-react">
<img src="https://img.shields.io/travis/jdf2e/nutui.svg?style=flat-square">
</a>
<a href="https://github.com/jdf2e/nutui-react">
<img src="https://img.shields.io/github/contributors/jdf2e/nutui-react" alt="GitHub contributors">
</a>
<a href="https://github.com/jdf2e/nutui-react">
<img src="https://img.shields.io/github/commit-activity/w/jdf2e/nutui-react" alt="GitHub commit activity">
</a>
<a href="https://github.com/jdf2e/nutui-react">
<img src="https://img.shields.io/github/issues-closed/jdf2e/nutui-react" alt="GitHub closed issues">
</a>
<a href="https://github.com/jdf2e/nutui">
<img src="https://img.shields.io/npm/l/@nutui/nutui-react.svg" alt="license"/>
</a>
<a href="https://www.npmjs.com/package/@nutui/nutui-react">
<img src="https://img.shields.io/npm/v/@nutui/nutui-react.svg?style=flat-square">
</a>
<a href="https://www.npmjs.com/package/@nutui/nutui-react">
<img src="https://img.shields.io/npm/dt/@nutui/nutui-react.svg?style=flat-square">
</a>
<a href="https://github.com/jdf2e/nutui">
<img src="https://img.shields.io/github/contributors/jdf2e/nutui-react" alt="GitHub contributors">
</a>
</p>
## 背景
随着 NutUI 的用户越来越多,在 NutUI 的交流群里对 React 版本的呼声也越来越高,我们积极响应社区的期待,于 2021 年年中开始规划并启动 React 版的开发,经过近半年的开发和打磨,将在 2022 年元旦前隆重推出 NutUI-React 元旦版。
## 组件开发状态
### 基础组件
- [ ] Button
- [ ] Cell
- [ ] Icon
- [ ] Layout
- [ ] Popup
- [ ] Toast
- [ ] Calendar
- [ ] Checkbox
- [ ] DatePicker
- [ ] Picker
- [ ] Radio
- [ ] Rate
- [ ] Switch
- [ ] Uploader
- [ ] ActionSheet
- [ ] Dialog
- [ ] Notify
- [ ] Overlay
- [ ] PullRefresh
- [ ] Badge
- [ ] Circle
- [ ] Collapse
- [ ] CountDown
- [ ] NoticeBar
- [ ] Steps
- [ ] NavBar
- [ ] Tab
- [ ] Tabbar
- [ ] TreeSelect
> Nut[nʌt],源自电影《冰河世纪》里松鼠 Scrat "执迷不悟",一生追求,即便引发大灾难也绝不松手的坚果。
---
## 特性
* 🚀 70+ 高质量组件(React 1.0 持续开发中),覆盖移动端主流场景
* 📖 基于京东APP 10.0 视觉规范
* 🍭 支持按需引用
* 📖 详尽的文档和示例
* 💪 支持 TypeScript
* 💪 支持服务端渲染(测试阶段)
* 🍭 支持定制主题
* 🍭 单元测试覆盖(1.0 开发中),保障稳定性
* 📖 提供 Sketch 设计资源
## 示例 H5 & 小程序
<p>
<img src="https://img12.360buyimg.com/imagetools/jfs/t1/202336/18/18586/7437/61b832ccE0b13d53d/18605da7232a5a0e.png" height="250" alt="NutUI" />
</p>
## 构建版本
> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版,非模块化环境(如通过 `<script>` 标签直接引用)建议使用 umd 压缩版。
* es **nutui.react.es.js**
* umd **nutui.umd.js**
## 链接
<ul>
<li>
<a href="https://github.com/jdf2e/nutui-react/discussions">
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 (用👍投票)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/labels/bug%203.0">
Bugs (用👍投票)
</a>
</li>
<li>
<a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion">
Question (用👍投票)
</a>
</li>
</ul>
[//]: # (## 开发交流)
[//]: # ()
[//]: # (| 版本 | 微信群 |内部咚咚群 |)
[//]: # (| --- | --- |--- |)
[//]: # (| [NutUI React]&#40;https://github.com/jdf2e/nutui-react/issues&#41; | 回复「NutUI」 | 1022619199)
[//]: # (| [NutUI Vue]&#40;https://github.com/jdf2e/nutui/issues&#41; | <img src="https://nutui.jd.com/3x/3.1.12/vx-code1.png" width="100" /> 关注后回复「NutUI」 | 82957939)
[//]: # (| [NutUI x Taro]&#40;https://github.com/jdf2e/nutui/issues&#41; | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> 关注后回复「NutUI」 | 1022545110 |)
[//]: # ()
[//]: # (## 贡献者们)
[//]: # ()
[//]: # (感谢以下小伙伴们为 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>)
## 参与共建
非常欢迎社区开发者为 NutUI 贡献代码,在贡献之前请先阅读 [贡献指南](https://nutui.jd.com/#/contributing),参与共建提 [PR](https://github.com/jdf2e/nutui/pulls)
感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui/graphs/contributors)
## 开发计划
[Milestones](https://github.com/jdf2e/nutui-react/projects)
## 更新日志
本项目遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153),更新日志请查阅 [Release](https://github.com/jdf2e/nutui-react/releases)
## 开源协议
本项目基于 **MIT** 协议
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册