Skip to content

Commit acaf772

Browse files
zhufuyizhufuyi
committed
update doc
1 parent ff5c7b4 commit acaf772

14 files changed

+15
-19
lines changed

‎README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ sponge is mainly based on **SQL** and **Protobuf** two ways to generate code, ea
2727
<p align="center">
2828
<img width="1500px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/sponge-framework.png">
2929
</p>
30-
<p align="center">Figure 1-1 sponge generation code framework diagram</p>
3130

3231
<br>
3332

@@ -46,7 +45,6 @@ sponge generated microservice code framework is shown in the figure below, which
4645
<p align="center">
4746
<img width="1000px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/microservices-framework.png">
4847
</p>
49-
<p align="center">Figure 1-2 Microservices framework diagram</p>
5048

5149
<br>
5250

‎assets/install-cn.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<br>
3030
<br>
3131

32-
### 在linux或macOS上安装sponge
32+
### linux或macOS环境
3333

3434
```bash
3535
# 安装sponge
@@ -48,7 +48,7 @@ sponge -v
4848
<br>
4949
<br>
5050

51-
### **Windows环境**
51+
### Windows环境
5252

5353
> 在windows环境中需要安装mingw64、make、cmder来支持linux命令环境才可以使用sponge。
5454

‎assets/install-en.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,10 @@ Check protoc version: `protoc --version`
2424

2525
After installing go and protoc, proceed to install Sponge. Sponge can be installed on Windows, macOS, and Linux environments.
2626

27-
> 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**
28-
2927
<br>
3028
<br>
3129

32-
### Installing Sponge on Linux or macOS
30+
### Linux or macOS Environment
3331

3432
```bash
3533
# Install Sponge
@@ -48,7 +46,7 @@ sponge -v
4846
<br>
4947
<br>
5048

51-
### **Windows Environment**
49+
### Windows Environment
5250

5351
> In the Windows environment, you need to install mingw64, make, and cmder to support the Linux command environment required by Sponge.
5452

‎assets/readme-cn.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ sponge包含丰富的组件(按需使用)：
5757
- 日志 [zap](https://go.uber.org/zap)
5858
- 数据库组件 [gorm](https://gorm.io/gorm)
5959
- 缓存组件 [go-redis](https://github.com/go-redis/redis), [ristretto](https://github.com/dgraph-io/ristretto)
60-
- 接口文档 [swagger](https://github.com/swaggo/swag)
60+
- 自动化api接口文档 [swagger](https://github.com/swaggo/swag), [protoc-gen-openapiv2](https://github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2)
6161
- 鉴权 [jwt](https://github.com/golang-jwt/jwt)
6262
- 校验 [validator](https://github.com/go-playground/validator)
6363
- 自适应限流 [ratelimit](https://github.com/zhufuyi/sponge/tree/main/pkg/shield/ratelimit)
@@ -67,7 +67,7 @@ sponge包含丰富的组件(按需使用)：
6767
- 服务注册与发现 [etcd](https://github.com/etcd-io/etcd), [consul](https://github.com/hashicorp/consul), [nacos](https://github.com/alibaba/)
6868
- 自适应采集 [profile](https://go.dev/blog/pprof)
6969
- 资源统计 [gopsutil](https://github.com/shirou/gopsutil)
70-
- 代码规范检查 [golangci-lint](https://github.com/golangci/golangci-lint)
70+
- 代码质量检查 [golangci-lint](https://github.com/golangci/golangci-lint)
7171
- 持续集成部署 CICD [jenkins](https://github.com/jenkinsci/jenkins), [docker](https://www.docker.com/), [kubernetes](https://github.com/kubernetes/kubernetes)
7272

7373
<br>

‎cmd/sponge/server/static/css/app.67faeeeb87f7fd4ba58388184084f965.css‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎cmd/sponge/server/static/css/app.67faeeeb87f7fd4ba58388184084f965.css.map‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎cmd/sponge/server/static/css/app.70d204e411002d242c162f650af3b8e7.css‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cmd/sponge/server/static/css/app.70d204e411002d242c162f650af3b8e7.css.map‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cmd/sponge/server/static/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
<!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;}
2-
.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>
1+
<!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;}
2+
.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>

‎cmd/sponge/server/static/js/app.0f16d231a5d4f391f5a6.js‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)