update doc

zhufuyi · Aug 20, 2023 · acaf772 · acaf772
1 parent ff5c7b4
commit acaf772
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,6 @@ sponge is mainly based on **SQL** and **Protobuf** two ways to generate code, ea
 <p align="center">
 <img width="1500px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/sponge-framework.png">
 </p>
-<p align="center">Figure 1-1 sponge generation code framework diagram</p>
 
 <br>
 
@@ -46,7 +45,6 @@ sponge generated microservice code framework is shown in the figure below, which
 <p align="center">
 <img width="1000px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/microservices-framework.png">
 </p>
-<p align="center">Figure 1-2 Microservices framework diagram</p>
 
 <br>
 

diff --git a/assets/install-cn.md b/assets/install-cn.md
@@ -29,7 +29,7 @@
 <br>
 <br>
 
-### 在linux或macOS上安装sponge
+### linux或macOS环境
 
 ```bash
 # 安装sponge
@@ -48,7 +48,7 @@ sponge -v
 <br>
 <br>
 
-### **Windows环境**
+### Windows环境
 
 > 在windows环境中需要安装mingw64、make、cmder来支持linux命令环境才可以使用sponge。
 

diff --git a/assets/install-en.md b/assets/install-en.md
@@ -24,12 +24,10 @@ Check protoc version: `protoc --version`
 
 After installing go and protoc, proceed to install Sponge. Sponge can be installed on Windows, macOS, and Linux environments.
 
-> If you cannot access the internet directly, when installing Sponge, you might encounter timeouts while fetching libraries from GitHub. It's recommended to set up a domestic proxy by executing the command **go env -w GOPROXY=https://goproxy.cn,direct**
-
 <br>
 <br>
 
-### Installing Sponge on Linux or macOS
+### Linux or macOS Environment
 
 ```bash
 # Install Sponge
@@ -48,7 +46,7 @@ sponge -v
 <br>
 <br>
 
-### **Windows Environment**
+### Windows Environment
 
 > In the Windows environment, you need to install mingw64, make, and cmder to support the Linux command environment required by Sponge.
 

diff --git a/assets/readme-cn.md b/assets/readme-cn.md
@@ -57,7 +57,7 @@ sponge包含丰富的组件(按需使用)：
 - 日志 [zap](https://go.uber.org/zap)
 - 数据库组件 [gorm](https://gorm.io/gorm)
 - 缓存组件 [go-redis](https://github.com/go-redis/redis), [ristretto](https://github.com/dgraph-io/ristretto)
-- 接口文档 [swagger](https://github.com/swaggo/swag)
+- 自动化api接口文档 [swagger](https://github.com/swaggo/swag), [protoc-gen-openapiv2](https://github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2)
 - 鉴权 [jwt](https://github.com/golang-jwt/jwt)
 - 校验 [validator](https://github.com/go-playground/validator)
 - 自适应限流 [ratelimit](https://github.com/zhufuyi/sponge/tree/main/pkg/shield/ratelimit)
@@ -67,7 +67,7 @@ sponge包含丰富的组件(按需使用)：
 - 服务注册与发现 [etcd](https://github.com/etcd-io/etcd), [consul](https://github.com/hashicorp/consul), [nacos](https://github.com/alibaba/)
 - 自适应采集 [profile](https://go.dev/blog/pprof)
 - 资源统计 [gopsutil](https://github.com/shirou/gopsutil)
-- 代码规范检查 [golangci-lint](https://github.com/golangci/golangci-lint)
+- 代码质量检查 [golangci-lint](https://github.com/golangci/golangci-lint)
 - 持续集成部署 CICD [jenkins](https://github.com/jenkinsci/jenkins), [docker](https://www.docker.com/), [kubernetes](https://github.com/kubernetes/kubernetes)
 
 <br>

diff --git a/cmd/sponge/server/static/css/app.67faeeeb87f7fd4ba58388184084f965.css b/cmd/sponge/server/static/css/app.67faeeeb87f7fd4ba58388184084f965.css
diff --git a/cmd/sponge/server/static/css/app.67faeeeb87f7fd4ba58388184084f965.css.map b/cmd/sponge/server/static/css/app.67faeeeb87f7fd4ba58388184084f965.css.map
diff --git a/cmd/sponge/server/static/css/app.70d204e411002d242c162f650af3b8e7.css b/cmd/sponge/server/static/css/app.70d204e411002d242c162f650af3b8e7.css
diff --git a/cmd/sponge/server/static/css/app.70d204e411002d242c162f650af3b8e7.css.map b/cmd/sponge/server/static/css/app.70d204e411002d242c162f650af3b8e7.css.map
diff --git a/cmd/sponge/server/static/index.html b/cmd/sponge/server/static/index.html
@@ -1,2 +1,2 @@
-<!DOCTYPE html><html><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>sponge generate code</title><link rel=icon type=image/png sizes=32x32 href="/static/img/favicon.png?v=1.0"><script type=text/javascript src=/static/appConfig.js async></script><link href=/static/css/app.67faeeeb87f7fd4ba58388184084f965.css rel=stylesheet></head><body style="margin: 0px; padding: 0px;"><style>.el-tooltip__popper {box-shadow: 3px 3px 10px 5px #d3d3d6;border-width: 0px !important;}
-      .el-tooltip__popper[x-placement^="top"] .popper__arrow:after {border-top-color: #dcdfe6 !important;}</style><div id=app></div><script type=text/javascript src=/static/js/manifest.2ae2e69a05c33dfc65f8.js></script><script type=text/javascript src=/static/js/vendor.f99d8d10a7d35fb68864.js></script><script type=text/javascript src=/static/js/app.c44311c277d7ebc58f75.js></script></body></html>
+<!DOCTYPE html><html><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>sponge generate code</title><link rel=icon type=image/png sizes=32x32 href="/static/img/favicon.png?v=1.0"><script type=text/javascript src=/static/appConfig.js async></script><link href=/static/css/app.70d204e411002d242c162f650af3b8e7.css rel=stylesheet></head><body style="margin: 0px; padding: 0px;"><style>.el-tooltip__popper {box-shadow: 3px 3px 10px 5px #d3d3d6;border-width: 0px !important;}
+      .el-tooltip__popper[x-placement^="top"] .popper__arrow:after {border-top-color: #dcdfe6 !important;}</style><div id=app></div><script type=text/javascript src=/static/js/manifest.2ae2e69a05c33dfc65f8.js></script><script type=text/javascript src=/static/js/vendor.f99d8d10a7d35fb68864.js></script><script type=text/javascript src=/static/js/app.0f16d231a5d4f391f5a6.js></script></body></html>
diff --git a/cmd/sponge/server/static/js/app.0f16d231a5d4f391f5a6.js b/cmd/sponge/server/static/js/app.0f16d231a5d4f391f5a6.js
diff --git a/cmd/sponge/server/static/js/app.0f16d231a5d4f391f5a6.js.map b/cmd/sponge/server/static/js/app.0f16d231a5d4f391f5a6.js.map
diff --git a/cmd/sponge/server/static/js/app.c44311c277d7ebc58f75.js b/cmd/sponge/server/static/js/app.c44311c277d7ebc58f75.js
diff --git a/cmd/sponge/server/static/js/app.c44311c277d7ebc58f75.js.map b/cmd/sponge/server/static/js/app.c44311c277d7ebc58f75.js.map
diff --git a/cmd/sponge/server/static/js/manifest.2ae2e69a05c33dfc65f8.js.map b/cmd/sponge/server/static/js/manifest.2ae2e69a05c33dfc65f8.js.map