From 33c6cf6961d5a6e005b253045eb6e4b432c15554 Mon Sep 17 00:00:00 2001
From: lihengwei <lihengwei@uniontech.com>
Date: Wed, 24 Apr 2024 14:57:58 +0800
Subject: [PATCH] feature: adjust README.md and README.en.md

Signed-off-by: lihengwei <lihengwei@uniontech.com>
---
 README.en.md | 69 ++++++++++++++++++++++++++++++++++++++++------------
 README.md    |  2 +-
 2 files changed, 55 insertions(+), 16 deletions(-)

diff --git a/README.en.md b/README.en.md
index b50b83fd..728c6d90 100644
--- a/README.en.md
+++ b/README.en.md
@@ -1,30 +1,69 @@
 # PilotGo-plugin-topology
 
-#### Description
+#### Introduction
 system application architecture detection.
 
 #### Software Architecture
-Software architecture description
+1. From the series: 
 
-#### Installation
+- agent: Kylin server-V10-SP3, nestos, openEuler-22.03-LTS-SP1 
+- server: Kylin Desktop V10-SP1, Kylin Server V10-SP3, nestos, openEuler-22.03-LTS-SP1, redhat9 
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+1. The development tools: 
 
-#### Instructions
+- golang >= 1.18、vue3、typescript、node.js > 14
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+1. The following is: 
 
-#### Contribution
+- pilotgo
+- neo4j
 
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
+![Alt text](docs/pilotgo-plugin-topo.png)
 
+#### Installation and usage tutorial
+
+1. Pull repository code
+
+```
+$ git clone https://gitee.com/openeuler/PilotGo-plugin-topology.git
+```
+
+2. Modify configuration file
+
+```
+$ mv topo_server.yaml.templete topo_server.yaml; vim topo_server.yaml
+$ mv topo_agent.yaml.templete topo_agent.yaml; vim topo_agent.yaml
+```
+
+3. front-end compilation
+
+```
+$ cd ./web
+$ yarn install
+$ yarn build
+```
+
+4. back-end compilation
+
+```
+$ cd ./agent
+$ go build -mod=vendor -o topoagent main.go
+$ cd ../server
+$ mv ../web/dist/* handler/
+$ go build -mod=vendor -tags=production toposerver main.go
+```
+
+5. run
+
+```
+Starting pilotgo and its related middleware, neo4j database on the management node；
+$ cd ./server
+$ ./toposerver -conf /topo_server.yaml file path
+将topoagent、topo_agent.yaml deploying the file to the corresponding directory on the business node；
+$ ./topoagent -conf /topo_agent.yaml file path
+```
+
+6. Open pilotgo web UI page, add and start topology plugin, view the topology page
 
 #### Gitee Feature
 
diff --git a/README.md b/README.md
index f1b533fc..4d56c829 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # PilotGo-plugin-topology
 
 #### 介绍
-System application architecture detection.
+系统应用架构检测。
 
 #### 软件架构
 1. 系统环境: 
-- 
Gitee