From 6d9934874644c8e80046755b7748d3972a820898 Mon Sep 17 00:00:00 2001 From: zhuyasen Date: Sun, 24 Mar 2024 15:24:53 +0800 Subject: [PATCH] update README --- README.md | 17 ++--------------- assets/readme-cn.md | 17 ++--------------- 2 files changed, 4 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 0d216315..31643d6d 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@
-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. +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. -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. +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.
@@ -191,19 +191,6 @@ No specific business logic code is included. See the [LICENSE](LICENSE) file for licensing information.
- -### How to contribute - -You are more than welcome to join us, raise an Issue or Pull Request. - -Pull Request instructions. - -1. Fork the code -2. Create your own branch: `git checkout -b feat/xxxx` -3. Commit your changes: `git commit -am 'feat: add xxxxx'` -4. Push your branch: `git push origin feat/xxxx` -5. Commit your pull request -
**If it's help to you, give it a star ⭐.** diff --git a/assets/readme-cn.md b/assets/readme-cn.md index 94cc63be..77ee118e 100644 --- a/assets/readme-cn.md +++ b/assets/readme-cn.md @@ -6,7 +6,7 @@
-如果开发只有CRUD api接口的web或微服务，不需要编写任何go代码就可以编译并部署到linux服务器、docker、k8s上，只需要连接到数据库(mysql、mongodb、postgresql、tidb、sqlite)就可以一键自动生成完整的服务代码。 +如果开发只有CRUD api接口的web或微服务，不需要编写任何go代码就可以编译并部署到linux服务器、docker、k8s上，只需要连接到数据库(mysql、mongodb、postgresql、tidb、sqlite)就可以一键自动生成完整的后端服务go代码。 如果开发通用的web或微服务，只需聚焦`在数据库定义表`、`在proto文件定义api描述信息`、`在生成的模板文件填写业务逻辑代码`三个核心部分，其他go代码都由sponge自动生成。 @@ -17,7 +17,7 @@ sponge生成的服务代码支持两种类型代码仓库： 1. **单体应用单体仓库(monolith)或微服务多仓库(multi-repo)**：每个服务代码都有自己的git仓库，即使把所有服务放在同一个git仓库下，服务之间代码不可以复用，默认是生成这种类型。 -2. **微服务单体仓库(mono-repo)**：在所有服务都在同一个git仓库下，不同服务之间的代码可以复用。 +2. **微服务单体仓库(mono-repo)**：所有服务都在同一个git仓库下，不同服务之间的代码可以复用，这种类型代码仓库也叫大仓库类型。
@@ -192,19 +192,6 @@ sponge run - [13 十分钟搭建一个微服务集群示例](https://www.bilibili.com/video/BV1YM4y127YK/)
- -### 如何贡献 - -非常欢迎您的加入，提 Issue 或 Pull Request。 - -Pull Request说明: - -1. Fork 代码 -2. 创建自己的分支: `git checkout -b feat/xxxx` -3. 提交你的修改: `git commit -am 'feat: add xxxxx'` -4. 推送您的分支: `git push origin feat/xxxx` -5. 提交pull request -
如果对您有帮助给个star⭐，欢迎加入**go sponge微信群交流**，加微信(备注`sponge`)进群。