Skip to content

Commit 0c369cd

Browse files
committed
update docs
1 parent da4d86a commit 0c369cd

File tree

4 files changed

+9
-11
lines changed

4 files changed

+9
-11
lines changed

README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
<br>
2121

22-
If you are develop web service or microservice with CRUD APIs, you don't need to write any Go code can be compiled and deployed to the linux server, docker, k8s, just need to connect to the database (mysql、mongodb、postgresql、tidb、sqlite) to generate a complete backend service Go code.
22+
If you are develop web or gRPC service with CRUD APIs, you don't need to write any Go code can be compiled and deployed to the linux server, docker, k8s, just need to connect to the database (mysql、mongodb、postgresql、tidb、sqlite) to generate a complete backend service Go code.
2323

24-
If you develop generic web or microservices, just focus on the three core parts of `define tables in the database`, `define api description information in the proto files`, `fill in business logic code in the generated template files`, and the rest of the Go code is automatically generated by sponge.
24+
If you develop generic web or gRPC service, just focus on the three core parts of `define tables in the database`, `define api description information in the proto files`, `fill in business logic code in the generated template files`, and the rest of the Go code is automatically generated by sponge.
2525

2626
<br>
2727

@@ -173,11 +173,6 @@ Detailed instructions for operating, configuring, and deploying a project using
173173

174174
- [Simple distributed order system](https://github.com/zhufuyi/sponge_examples/tree/main/9_order-grpc-distributed-transaction)
175175

176-
<br>
177-
178-
### License
179-
180-
See the [LICENSE](LICENSE) file for licensing information.
181176

182177
<br>
183178
<br>

assets/install-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ sponge -v
3535
注意:
3636

3737
- 使用sponge开发项目时,请使用git bash终端,不要使用系统默认的cmd,否则会出现找不到命令的错误。
38-
- 不要在`GOBIN`目录下打开终端来执行命令`sponge run`
38+
- 不要在`GOBIN`目录(sponge可执行文件所在的目录)下打开终端来执行命令`sponge run`
3939

4040
在windows除了上面安装sponge方式,还提供了原生安装,点击查看【安装 sponge】 --> 【windows环境】[安装文档](https://go-sponge.com/zh-cn/quick-start?id=%e5%ae%89%e8%a3%85-sponge)
4141

assets/install-en.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ sponge init
2929
sponge -v
3030
```
3131

32-
> Note: When using sponge development, please use git bash terminal, do not use the system default cmd, otherwise there will be an error that cannot find the command.
32+
Note:
33+
34+
- When using sponge development, please use git bash terminal, do not use the system default cmd, otherwise there will be an error that cannot find the command.
35+
- Do not open a terminal in the `GOBIN` directory (the directory where the sponge executable is located) to execute the command `sponge run`.
3336

3437
In addition to the above installation of sponge in windows, it also provides native installation, click to view **Installing Sponge** --> **Windows Environment** [installation documentation](https://go-sponge.com/quick-start?id=installing-sponge).
3538

assets/readme-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
<br>
88

9-
如果开发只有CRUD api的web或微服务,不需要编写任何go代码就可以编译并部署到linux服务器、docker、k8s上,只需要连接到数据库(mysql、mongodb、postgresql、tidb、sqlite)就可以一键自动生成完整的后端服务go代码。
9+
如果开发只有CRUD api的web或gRPC服务,不需要编写任何go代码就可以编译并部署到linux服务器、docker、k8s上,只需要连接到数据库(mysql、mongodb、postgresql、tidb、sqlite)就可以一键自动生成完整的后端服务go代码。
1010

11-
如果开发通用的web或微服务,只需聚焦`在数据库定义表``在proto文件定义api描述信息``在生成的模板文件填写业务逻辑代码`三个核心部分,其他go代码都由sponge自动生成。
11+
如果开发通用的web或gRPC务,只需聚焦`在数据库定义表``在proto文件定义api描述信息``在生成的模板文件填写业务逻辑代码`三个核心部分,其他go代码都由sponge自动生成。
1212

1313
<br>
1414

0 commit comments

Comments
 (0)