diff --git a/README.md b/README.md index 30a8b8ae1ae645e281765c59d7290af77dc4361f..34c6ac737ee3e99bcbfff934c764ba749923fe6c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +

logo

@@ -6,61 +7,125 @@

- PRs Welcome + PRs Welcome - - Coverage Status - - - - - - GitHub contributors - - - GitHub commit activity - - - GitHub closed issues - + + + +license + + + + + + + + + + GitHub contributors +

-## 背景 - -随着 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 & 小程序 + +

+ NutUI +

+ + +## 构建版本 + +> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版,非模块化环境(如通过 `