diff --git a/README.md b/README.md index 35209b7..15a8dcd 100644 --- a/README.md +++ b/README.md @@ -1,183 +1 @@ -

- logo -

- -

JD-style mobile UI components based on React that support users to develop H5 and mini-programs.

- -

- - PRs Welcome - - - license - - - - - - - - - GitHub contributors - - - GitHub Release Date - - - GitHub commit activity - -

- -

- NutUI-React   - NutUI-React -

- ---- - -> 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_ZH.md) | English - -## Features - -- 🚀 70+ High Quality Components -- 📖 Based on JD APP 11.0 Visual Specifications -- 🍭 Support Tree Shaking -- 📖 Extensive Documentation and Demos -- 💪 Written in TypeScript -- 💪 Support SSR (Experimental) -- 🍭 Support Custom Themes -- 🍭 90%+ Unit Test Coverage -- 📖 Provide Sketch Design Resources - -## Running locally - -### running with H5 - -```sh -# Clone repository -git clone https://github.com/jdf2e/nutui-react.git - -# Enter the project dictionary -cd nutui-react - -# Install dependencies -pnpm install - -# Start development -pnpm run dev - -# visit in browser: http:http://localhost:3000 (you don't have to open it manually if you've run it in the browser again) -``` - -### running with mini-program - -```sh -# Clone repository -git clone https://github.com/jdf2e/nutui-react.git - -# Enter the project dictionary -cd nutui-react - -# Install dependencies -pnpm install - -# Start development -# dir:packages/nutui-taro-demo/dist/weapp -pnpm run dev:taro:weapp - -# OR run as jd mini-program -# dir:packages/nutui-taro-demo/dist/jd -pnpm run dev:taro:jd -``` - -## 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 `