Skip to content

Commit 1626ec7

Browse files
committed
update doc
1 parent 45e77dd commit 1626ec7

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@
1818

1919
<br>
2020

21+
If you are developing a web or microservice with a simple CRUD API interface, you don't need to write a single line of golang code to compile and deploy to servers, dockers, k8s, and the complete service code is generated by sponge.
22+
23+
If you develop a generic web or microservice, you need to manually write code in addition to defining the data table, defining the api interface in the proto file, and filling in the specific business logic code in the generated template file. Other golang codes are generated by sponge.
24+
25+
<br>
26+
2127
### sponge generates the code framework
2228

2329
sponge is mainly based on **SQL** and **Protobuf** two ways to generate code, each way has to generate code for different functions.

assets/readme-cn.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
<br>
44

5+
如果开发只有简单CRUD api接口的web或微服务,不需要编写一行golang代码就可以编译并部署到服务器、docker、k8s上,完整的服务代码由sponge一键生成。
6+
7+
如果开发通用的web或微服务,除了定义数据表、在proto文件定义api接口、在生成的模板文件填写具体业务逻辑代码这三个部分需要人工编写代码,其他golang代码都由sponge生成。
8+
9+
<br>
10+
511
### 生成代码框架
612

713
sponge主要基于**SQL****Protobuf**两种方式生成代码,每种方式拥有生成不同功能代码。

0 commit comments

Comments
 (0)