feat: 还原文档

anyone-yuren · Nov 16, 2023 · a16b777 · a16b777
1 parent 6d92bc7
commit a16b777
Showing 1 changed file with 36 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,44 @@
-# React + TypeScript + Vite
+简体中文 | [English](./README.en-US.md)
 
-这个模板提供了一个最小化的设置，使得在 Vite 中使用 React 可以实现热模块替换（HMR），并包含一些 ESLint 规则。
+<h1 align="center">MUI PAD HMI</h1>
 
-目前，有两个官方插件可用：
+<div align="center">
+
+项目使用react material ui以及react-spring/web构建，更多是动画层面设计，结构本身不复杂，目前阶段可做参考与学习，后续看需求变化，再进行nomorepo改造。
+![starter-antd-admin-crud-auth-mern-crud-auth](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5f30a22d75954c7bb0021323326df08d~tplv-k3u1fbpfcp-jj-mark:3024:0:0:0:q75.awebp#?w=1176&h=818&s=4244265&e=gif&f=160&b=140630)
 
-- @vitejs/plugin-react 使用 Babel 实现快速刷新（Fast Refresh）
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) 使用 [SWC](https://swc.rs/) 实现快速刷新（Fast Refresh）
+[![MIT](https://img.shields.io/github/license/iczer/vue-antd-admin)](https://github.com/iczer/vue-antd-admin/blob/master/LICENSE)
 
-## 扩展 ESLint 配置
+</div>
 
-如果你正在开发一个生产应用程序，建议更新配置以启用类型感知的 lint 规则：
+- 预览地址：https://anyone-yuren.github.io/mui-pad-hmi/
 
-- 配置顶级的 parserOptions 属性如下：
+## 浏览器支持
 
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
+现代浏览器及 IE10
+
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| IE10, Edge                                                                                                                                                                                                      | last 2 versions                                                                                                                                                                                                   | last 2 versions                                                                                                                                                                                               | last 2 versions                                                                                                                                                                                               | last 2 versions                                                                                                                                                                                           |
+
+## 使用
+
+### clone
+
+```bash
+$ git clone https://github.com/anyone-yuren/mui-pad-hmi.git
+```
+
+### yarn
+
+```bash
+$ yarn install
+$ yarn dev
+```
+
+### or pnpm
+
+```
+$ pnpm i
+$ pnpm dev
 ```