From 2bf97c6cc0f8a039cafb5a793898d096bad50e29 Mon Sep 17 00:00:00 2001
From: azhengzz <820108271@qq.com>
Date: Wed, 3 Feb 2021 09:39:28 +0800
Subject: [PATCH] update readme

---
 README.md | 65 ++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 40 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index a28ee0d..234f4a2 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,52 @@
 # ApiAutomationTest
 
-#### 介绍
-接口自动化测试平台，
+接口自动化测试平台`ApiAutomationTest`
 
-#### 软件架构
-软件架构说明
+使用她可以像`PostMan`一样进行单个或多个接口调试，或像`JMeter`一样使用逻辑控制器组件对案例步骤进行流程控制。
+测试案例当然少不了期望断言的设置，她可以方便的为请求接口设置期望断言和脚本断言。
+她同时也提供了例如定时器、变量定义、脚本等工具组件，您可以使用不同类型的组件编写出丰富测试案例场景。
+您还可以为项目配置定时任务来周期或定时触发执行。案例执行完毕后查看报告，支持执行结果钉钉通知。
+
+## 内容列表
+- [背景](#背景)
+- [软件架构](#软件架构)
+- [安装](#安装)
+
+## 背景
+(待补充...)
 
 
-#### 安装教程
+## 软件架构
+- 后端 Python + Flask
+- 前端 Bootstrap4 + JS&JQuery
+- 依赖库(后端核心第三方库)
+    - Flask
+    - Flask-SQLAlchemy
+    - Flask-Migrate
+    - Flask-SocketIO
+    - requests
+    - PyMySQL
+    - paramiko
+    - APScheduler
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+## 安装
+开发环境和生产环境使用的是Python3.6版本，理论上>=py3.6都可以，建议大家使用`Python3.6`版本。
 
-#### 使用说明
+- 第一步: 安装Python第三方库
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+使用pip工具安装
+```
+pip install -r requirements.txt
+```
+国内可以使用douban的镜像源快速下载
+```
+pip install -r requirements.txt -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com
+```
 
-#### 参与贡献
+- 第二步: 初始化数据库
 
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+执行命令`flask init`
 
+- 第三步: 启动服务
 
-#### 特技
-
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+执行命令`python webserver.py`