Skip to content

Commit 6d99348

Browse files
committed
update README
1 parent 41ea4fd commit 6d99348

File tree

2 files changed

+4
-30
lines changed

2 files changed

+4
-30
lines changed

README.md

Lines changed: 2 additions & 15 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 service code.
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.
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 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.
2525

2626
<br>
2727

@@ -191,19 +191,6 @@ No specific business logic code is included.
191191
See the [LICENSE](LICENSE) file for licensing information.
192192

193193
<br>
194-
195-
### How to contribute
196-
197-
You are more than welcome to join us, raise an Issue or Pull Request.
198-
199-
Pull Request instructions.
200-
201-
1. Fork the code
202-
2. Create your own branch: `git checkout -b feat/xxxx`
203-
3. Commit your changes: `git commit -am 'feat: add xxxxx'`
204-
4. Push your branch: `git push origin feat/xxxx`
205-
5. Commit your pull request
206-
207194
<br>
208195

209196
**If it's help to you, give it a star ⭐.**

assets/readme-cn.md

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

77
<br>
88

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

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

@@ -17,7 +17,7 @@
1717
sponge生成的服务代码支持两种类型代码仓库:
1818

1919
1. **单体应用单体仓库(monolith)或微服务多仓库(multi-repo)**:每个服务代码都有自己的git仓库,即使把所有服务放在同一个git仓库下,服务之间代码不可以复用,默认是生成这种类型。
20-
2. **微服务单体仓库(mono-repo)**在所有服务都在同一个git仓库下,不同服务之间的代码可以复用。
20+
2. **微服务单体仓库(mono-repo)**所有服务都在同一个git仓库下,不同服务之间的代码可以复用,这种类型代码仓库也叫大仓库类型
2121

2222
<br>
2323

@@ -192,19 +192,6 @@ sponge run
192192
- [13 十分钟搭建一个微服务集群示例](https://www.bilibili.com/video/BV1YM4y127YK/)
193193

194194
<br>
195-
196-
### 如何贡献
197-
198-
非常欢迎您的加入,提 Issue 或 Pull Request。
199-
200-
Pull Request说明:
201-
202-
1. Fork 代码
203-
2. 创建自己的分支: `git checkout -b feat/xxxx`
204-
3. 提交你的修改: `git commit -am 'feat: add xxxxx'`
205-
4. 推送您的分支: `git push origin feat/xxxx`
206-
5. 提交pull request
207-
208195
<br>
209196

210197
如果对您有帮助给个star⭐,欢迎加入**go sponge微信群交流**,加微信(备注`sponge`)进群。

0 commit comments

Comments
 (0)