Add readme describe.v2.0.5

1 files changed, 38 insertions, 11 deletions

diff --git a/README.md b/README.md
index 02c6eeb..1ec4cc7 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,38 @@
-此项目是自动功能验证测试用例的实现，实现了包括拦截策略为bypass，intercept，redirect，block，replace，hijack，block，instert的情况下的测试用例

-

-主要包括以下目录：

-1、badssl.com  模拟https中证书可能出现的情况

-2、docker-compose 存放docker-compose.yml文件的目录

-3、unittest_python 是存放执行测试用例的python文件和生成相关docker镜像的dockerfile文件

-#4、wpr_golang 是存放web page replay 的执行文件和生成相关镜像的dockerfile文件

-

-

-

-

+# TSG Diagnose

+TSG Diagnose is a tool designed to check the basic functionality and availability of TSG.

+## Introduction

+TSG Diagnose comprises multiple test cases, each simulating real user requests. The outcome of these requests determines whether a case is successful. 

+TSG Diagnose uses containers to construct realistic client and server environments for these tests. 

+Currently, the TSG Diangose feature supports running in both Docker and k3s environments.

+## Installation

+You can install TSG Diagnose RPM on a TSG-OS machine. Ensure that you install the TSG-OS YUM repository before proceeding with the installation.

+```bash

+dnf install tsg-diagnose

+```

+### Docker

+If you have installed TSG Diagnose with Docker support, you can use the following command to build the TSG Diagnose runtime environment.

+```bash

+docker load < /opt/tsg/tsg-diagnose/images/server_web.tar

+docker load < /opt/tsg/tsg-diagnose/images/server_dns.tar

+docker load < /opt/tsg/tsg-diagnose/images/client.tar

+docker-compose down --remove-orphans; docker-compose up -d --remove-orphans

+```

+### k3s

+If you have installed TSG Diagnose with k3s support, you can use the following command to build the TSG Diagnose runtime environment.

+```bash

+k3s ctr image import /opt/tsg/tsg-diagnose/images/server_web.tar

+k3s ctr image import /opt/tsg/tsg-diagnose/images/server_dns.tar

+k3s ctr image import /opt/tsg/tsg-diagnose/images/client.tar

+kubectl apply -f /opt/tsg/tsg-diagnose/k8s-resource/tsg-diagnose-client.yaml

+kubectl apply -f /opt/tsg/tsg-diagnose/k8s-resource/tsg-diagnose-server.yaml

+```

+## Usage

+There are two commands available to run TSG Diagnose:

+1. tsg-diagnose-oneshot: Runs the test cases in a one-shot mode.

+2. tsg-diagnose-periodical: Runs the test cases periodically.

+```bash

+# Run test cases once

+tsg-diagnose-oneshot

+# Run test cases periodically

+tsg-diagnose-periodical

+```
\ No newline at end of file