From 389d67d8e566b9c34688be8dc9b596a7211b5215 Mon Sep 17 00:00:00 2001
From: Tevin <tingquanren@163.com>
Date: Thu, 02 Apr 2026 11:09:48 +0800
Subject: [PATCH] docs: 精简 README.md 并创建项目 CLAUDE.md
---
CLAUDE.md | 33 ++++++++++++++++
README.md | 74 +------------------------------------
2 files changed, 35 insertions(+), 72 deletions(-)
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..f5bafe1
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,33 @@
+# CLAUDE.md
+
+本文件为 Claude Code 在本项目中工作提供指导
+
+## 项目概述
+
+- **项目类型**: React + TypeScript + Vite 组件库
+- **UI 框架**: Ant Design
+- **包管理器**: pnpm
+- **代码规范**: ESLint (类型检查 + React X + React DOM)
+
+## 技术栈
+
+- React 19
+- TypeScript 5.9
+- Vite 8
+- Ant Design 6.3.5
+- ESLint 9 (Flat Config)
+
+## 可用脚本
+
+```bash
+pnpm dev # 启动开发服务器
+pnpm build # 构建生产版本
+pnpm preview # 预览生产版本
+pnpm lint # 运行 ESLint
+```
+
+## 开发规范
+
+- 使用 TypeScript 严格模式
+- ESLint 配置了类型检查规则，提交前需通过 lint
+- 组件开发遵循函数式组件 + Hooks 模式
\ No newline at end of file
diff --git a/README.md b/README.md
index 7dbf7eb..313bcb4 100644
--- a/README.md
+++ b/README.md
@@ -1,73 +1,3 @@
-# React + TypeScript + Vite
+# admin2-components
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
-
-## React Compiler
-
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default defineConfig([
- globalIgnores(['dist']),
- {
- files: ['**/*.{ts,tsx}'],
- extends: [
- // Other configs...
-
- // Remove tseslint.configs.recommended and replace with this
- tseslint.configs.recommendedTypeChecked,
- // Alternatively, use this for stricter rules
- tseslint.configs.strictTypeChecked,
- // Optionally, add this for stylistic rules
- tseslint.configs.stylisticTypeChecked,
-
- // Other configs...
- ],
- languageOptions: {
- parserOptions: {
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
- tsconfigRootDir: import.meta.dirname,
- },
- // other options...
- },
- },
-])
-```
-
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default defineConfig([
- globalIgnores(['dist']),
- {
- files: ['**/*.{ts,tsx}'],
- extends: [
- // Other configs...
- // Enable lint rules for React
- reactX.configs['recommended-typescript'],
- // Enable lint rules for React DOM
- reactDom.configs.recommended,
- ],
- languageOptions: {
- parserOptions: {
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
- tsconfigRootDir: import.meta.dirname,
- },
- // other options...
- },
- },
-])
-```
+基于 React + TypeScript + Vite 的组件库项目
\ No newline at end of file
--
Gitblit v1.9.1