更新 README文档

README.md

@@ -1,3 +1,40 @@
 # nodeServer
 
-由typescript编写的node.js通用后端服务框架
+由typescript编写的node.js通用后端服务框架
+
+## 使用说明
+
+1. 将项目克隆到本地：
+```sh
+git clone <repository-url>
+```
+
+2. 安装依赖
+```sh
+npm i
+```
+
+3. 启动服务npm start
+```sh
+npm start
+```
+
+## 开发说明
+* src/index.ts 启动文件，包含API注册
+* src/config.ts 项目配置文件
+* src/lib/* 该目录为框架库文件目录，一般无需进行修改
+* src/api/* 该目录为API响应函数目录，API放在该位置，在这里进行开发（添加后需要在启动文件中进行API注册）
+
+## 版本说明
+
+### v1.0.0 
+* 构建 基础框架
+* 添加 API中间件【MountIP】
+* 添加 API中间件【MountUserAgent】
+* 添加 API中间件【Unbind】
+
+## 分支说明
+* master 主分支，主要用于版本发布
+* dev 通用开发分支
+* db 数据库分支，专注数据库连接的开发
+* captcha 验证码分支，专注人机验证的开发