diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12915ef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# 项目说明
+
+## 功能
+#### 功能与星锁app相同，在其基础上简化
+
+## 使用工具
+#### HBuilderX + 微信开发者工具（推荐使用IntelliJ工具编写，HBuilderX代码提示等功能做的较差）
+
+## 技术栈
+#### Uni-app创建的Vue3项目
+#### 运行只需npm i 安装依赖，然后在HBuilderX中运行即可
+
+## 目录
+1. api 项目接口
+2. config 项目不同环境配置
+3. pages 项目页面
+4. static 项目静态资源
+5. stores 项目全局状态管理
+6. utils 项目公共方法
+
+## 公共方法
+#### 示例在index页面中，后续添加公共方法会在文档中说明
+1. utils/request 请求方法（目前不了解服务端返回规则，仍需完善）
+2. pinia 全局状态管理
+3. uview-plus Uni-app常用UI组件库，且提供很多常用api [官方文档](https://uiadmin.net/uview-plus/components/intro.html)