From 419cce6c866cf8c8f3463934c7e7be4c940925ba Mon Sep 17 00:00:00 2001
From: taoran <taoran0796@163.com>
Date: Fri, 1 Dec 2023 17:39:00 +0800
Subject: [PATCH] docs: readme.md

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 45 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 2d10694..30746a2 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,49 @@
-基于Vite4.x + Vue3.x + ElementPlus + Typescript开发的工具平台
+# 基于Vite4.x + Vue3.x + ElementPlus + Typescript + Tailwind开发的工具平台
 
+[![license](https://img.shields.io/github/license/taoran1401/tools-web)](LICENSE)
 
+> 演示站点：https://tools.ranblogs.com
 
-# 工具站
+# 快速使用
 
-包含工具：
-- 时间戳转换
-- MD5在线加密
-- Json在线转换
-- 正则测试工具
-- Unicode转中文
-- 字数统计
-- IP查询
-- 常用进制转换
-- 在线图片处理
-- 持续补充...
+安装`pnpm`, 为避免因为不同包管理器工具下载同一个依赖,可能版本不一样的问题,本项目强制使用`pnpm`
+```
+npm install pnpm -g
+```
+
+克隆
+```
+git clone --depth=1 https://github.com/taoran1401/tools-web.git
+```
+
+安装
+```
+# 进入项目
+cd tools-web
+
+# 复制配置文件
+cp .env.example .env.development
+
+# 安装
+pnpm install
+```
+
+启动
+```
+pnpm dev
+```
+
+打包
+```
+pnpm build:dev
+```
+
+# 技术栈
+
+- 编程语言: TypeScript + JavaScript
+- 构件工具: Vite4.x
+- 前端框架: Vue3.x
+- 路由工具: Vue Router
+- 状态管理: Pinia
+- Ui框架: ElementPlus + Tailwindcss
+- Http工具: Axios
\ No newline at end of file