diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a87a54
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# vue-uniapp-template
+
+## 介绍
+基于 uni-app + Vue 3 + TypeScript 的项目，集成了 ESLint、Prettier、Stylelint、Husky 和 Commitlint 等工具，确保代码规范与质量。
+
+![输入图片说明](https://i-blog.csdnimg.cn/direct/2c0eaeaa15134517a77b7a1689388537.gif)
+
+## 项目启动
+
+安装依赖
+```
+pnpm install
+```
+
+h5启动
+```
+pnpm run dev:h5
+```
+
+访问 [http://localhost:4096](http://localhost:4096)
\ No newline at end of file