update README

zhufuyi · zhufuyi · commit 446d528e3783 · 2024-09-19T22:05:08.000+08:00
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@
 Sponge's core design concept is to reversely generate modular code through `SQL` or `Protobuf` files. These codes can be flexibly and seamlessly combined into various types of backend services, thus greatly improving development efficiency and simplifying backend service development. Sponge's main goals are as follows:
 
 - If you develop a web or gRPC service with only CRUD API, you don't need to write any go code to compile and deploy it to Linux servers, dockers, k8s, and you just need to connect to the database to automatically generate the complete backend service go code by sponge.
-- If you develop general web, gRPC, http+gRPC, gRPC gateway services, you only need to focus on the three core parts of `define tables in the database`, `define API description information in the proto file`, and `fill in business logic code in the generated template file`, and other go codes (including CRUD api) are generated by sponge.
+- If you develop general web, gRPC, http+gRPC, gRPC gateway services, you only need to focus on the three core parts of `define tables in the database`, `define API description information in the protobuf file`, and `fill in business logic code in the generated template file`, and other go codes (including CRUD api) are generated by sponge.
 
 <br>
 
@@ -83,6 +83,7 @@ Click to view the [**test code**](https://github.com/zhufuyi/microservices_frame
 - Crontab [cron](https://github.com/robfig/cron)
 - Message Queue [rabbitmq](https://github.com/rabbitmq/amqp091-go), [kafka](https://github.com/IBM/sarama)
 - Distributed Transaction Manager [dtm](https://github.com/dtm-labs/dtm)
+- Distributed lock [dlock](https://github.com/zhufuyi/sponge/tree/main/pkg/dlock)
 - Parameter validation [validator](https://github.com/go-playground/validator)
 - Adaptive rate limiting [ratelimit](https://github.com/zhufuyi/sponge/tree/main/pkg/shield/ratelimit)
 - Adaptive circuit breaking [circuitbreaker](https://github.com/zhufuyi/sponge/tree/main/pkg/shield/circuitbreaker)
@@ -98,20 +99,19 @@ Click to view the [**test code**](https://github.com/zhufuyi/microservices_frame
 
 ### Project Code Directory Structure
 
-The project code directory structure created by sponge follows the [project-layout](https://github.com/golang-standards/project-layout) and is structured as follows. Supported repository types are `monolithic application single repository (monolith)`, `microservice multi-repository (multi-repo)`, `microservice single repository (mono-repo)`.
+The project code directory structure created by sponge follows the [project-layout](https://github.com/golang-standards/project-layout).
+
+Here is the directory structure for the generated `monolithic application single repository (monolith)` or `microservice multi-repository (multi-repo)` code:
 
 ```bash
 .
-├── api            # Directory for exposing external API interfaces, typically containing proto files and generated *.pb.go files. The directory structure is typically in the form `api/xxx/v1`, where v1 indicates the version.
+├── api            # Protobuf files and generated * pb.go directory
 ├── assets         # Store various static resources, such as images, markdown files, etc.
 ├── cmd            # Program entry directory
-│    └── serviceName
-│         ├── initial     # Program initialization, consisting of three files: initApp initializes configurations, registerServers registers services (HTTP or grpc), and registerClose registers resource cleanup.
-│         └── main.go     # Program entry file
 ├── configs        # Directory for configuration files
-├── deployments    # Directory for deployment scripts, supporting Bare Metal, Docker and Kubernetes deployments.
-├─ docs            # Directory for API interface Swagger documentation.
-├── i(I)nternal       # Directory for business logic code, if the first letter is lowercase (internal), it means private code, if the first letter is capitalised (Internal), it means it can be reused by other code.
+├── deployments    # Bare metal, docker, k8s deployment script directory.
+├── docs           # Directory for API interface Swagger documentation.
+├── internal       # Directory for business logic code.
 │    ├── cache        # Cache directory wrapped around business logic.
 │    ├── config       # Directory for Go structure configuration files.
 │    ├── dao          # Data access directory.
@@ -124,9 +124,32 @@ The project code directory structure created by sponge follows the [project-layo
 │    ├── service      # Directory for implementing grpc business functionality (specific to grpc services).
 │    └── types        # Directory for defining request and response parameter structures for HTTP.
 ├── pkg            # Directory for shared libraries.
-├── scripts        # Directory for scripts, including compilation, execution, code generation, and deployment scripts.
+├── scripts        # Directory for scripts.
 ├── test           # Directory for scripts required for testing services  and test SQL.
-└── third_party    # Directory for external helper programs, forked code, and other third-party tools.
+├── third_party    # Directory for third-party protobuf files or external helper programs.
+├── Makefile       # Develop, test, deploy related command sets .
+├── go.mod         # Go module dependencies and version control file.
+└── go.sum         # Go module dependencies key and checksum file.
+```
+
+<br>
+
+Here is the directory structure for the generated `microservice monolithic repository (mono-repo)` code (also known as large repository directory structure):
+
+```bash
+.
+├── api
+│    ├── server1       # Protobuf files and generated *pb.go directory for service 1.
+│    ├── server2       # Protobuf files and generated *pb.go directory for service 2.
+│    ├── server3       # Protobuf files and generated *pb.go directory for service 3.
+│    └── ...
+├── server1        # Code directory for Service 1, it has a similar structure to the microservice multi repo directory.
+├── server2        # Code directory for Service 2, it has a similar structure to the microservice multi repo directory.
+├── server3        # Code directory for Service 3, it has a similar structure to the microservice multi repo directory.
+├── ...
+├── third_party    # Third-party protobuf files.
+├── go.mod         # Go module dependencies and version control file.
+└── go.sum         # Go module dependencies' checksums and hash keys.
 ```
 
 <br>
diff --git a/assets/install-cn.md b/assets/install-cn.md
@@ -11,6 +11,19 @@
 
 ### Windows环境
 
+安装sponge之前确保已安装go语言环境，并把`GOBIN`添加到系统环境变量**path**，如果已经设置过可以跳过此步骤：
+
+```bash
+    # 检查GOBIN目录是否存在
+    go env GOBIN
+    
+    # 如果为空，设置GOBIN(例如：D:\go\bin)，可能需要管理员权限
+    go env -w GOBIN=D:\go\bin
+    # 然后并把GOBIN目录添加到系统path环境变量
+```
+
+<br>
+
 > 因为sponge依赖一些linux命令，因此在windows环境中需要安装git bash、make来支持linux命令环境。
 
 为了安装方便，已经把sponge及其依赖的程序打包在一起，下载地址(选择一个下载即可)：
@@ -25,7 +38,7 @@
 (2) 在任意文件夹下右键(显示更多选项)，选择【Open Git Bash here】打开git bash终端：
 
 ```bash
-# 初始化sponge，自动安装sponge依赖插件
+# 初始化sponge
 sponge init
 
 # 查看sponge版本
diff --git a/assets/install-en.md b/assets/install-en.md
@@ -9,10 +9,21 @@ Recommended to use go version 1.20 or above, [https://go.dev/doc/install](https:
 
 ### Windows Environment
 
-> Because sponge depends on some linux commands, git bash and make need to be installed in windows to support the linux command environment.
+Make sure the go locale is installed before installing sponge, and add `GOBIN` to the system environment variable **path**. If it is already set, skip this step:
+
+ ```bash 
+     #Check if GOBIN directory exists 
+     go env GOBIN 
+    
+     #If empty, GOBIN needs to be set (e.g. D:\go\bin), administrator privileges may be required 
+     go env -w GOBIN=D:\go\bin 
+     #Then add GOBIN directory to system path environment variable 
+ ``` 
 
 <br>
 
+> Because sponge depends on some linux commands, git bash and make need to be installed in windows to support the linux command environment.
+
 For installation convenience, sponge and its dependent programs have been packaged together, download address: [sponge-install.zip](https://drive.google.com/drive/folders/1T55lLXDBIQCnL5IQ-i1hWJovgLI2l0k1?usp=sharing)
 
 After downloading the file:
diff --git a/assets/readme-cn.md b/assets/readme-cn.md
@@ -11,7 +11,7 @@
 sponge 的核心设计理念是通过 `SQL` 或 `Protobuf` 文件逆向生成模块化的代码，这些代码可以灵活、无缝地组合成多种类型的后端服务，从而大大提升开发效率，简化后端服务开发，sponge 的主要目标如下：
 
 - 如果开发只有 CRUD api 的 web 或 gRPC 服务，不需要编写任何 go 代码就可以编译并部署到 linux 服务器、docker、k8s 上，只需要连接到数据库就可以一键自动生成完整的后端服务 go 代码。
-- 如果开发通用的 web、gRPC、http+gRPC、gRPC 网关等服务，只需聚焦`在数据库定义表`、`在proto文件定义api描述信息`、`在生成的模板文件填写业务逻辑代码`三个核心部分，其他 go 代码(包括CRUD api)都由 sponge 来生成。
+- 如果开发通用的 web、gRPC、http+gRPC、gRPC 网关等服务，只需聚焦`在数据库定义表`、`在protobuf文件定义api描述信息`、`在生成的模板文件填写业务逻辑代码`三个核心部分，其他 go 代码(包括CRUD api)都由 sponge 来生成。
 
 <br>
 
@@ -71,6 +71,7 @@ sponge包含丰富的组件(按需使用)：
 - 定时任务 [cron](https://github.com/robfig/cron)
 - 消息队列组件 [rabbitmq](https://github.com/rabbitmq/amqp091-go), [kafka](https://github.com/IBM/sarama)
 - 分布式事务管理器 [dtm](https://github.com/dtm-labs/dtm)
+- 分布式锁 [dlock](https://github.com/zhufuyi/sponge/tree/main/pkg/dlock)
 - 自适应限流 [ratelimit](https://github.com/zhufuyi/sponge/tree/main/pkg/shield/ratelimit)
 - 自适应熔断 [circuitbreaker](https://github.com/zhufuyi/sponge/tree/main/pkg/shield/circuitbreaker)
 - 链路跟踪 [opentelemetry](https://github.com/open-telemetry/opentelemetry-go)
@@ -85,17 +86,19 @@ sponge包含丰富的组件(按需使用)：
 
 ### 目录结构
 
-生成的服务代码目录结构遵循 [project-layout](https://github.com/golang-standards/project-layout)，代码目录结构如下所示。支持的仓库类型有`单体应用单体仓库(monolith)`、`微服务多仓库(multi-repo)`、`微服务单体仓库(mono-repo)`。
+生成的服务代码目录结构遵循 [project-layout](https://github.com/golang-standards/project-layout)。
+
+这是生成的`单体应用单体仓库(monolith)`或`微服务多仓库(multi-repo)`代码目录结构：
 
 ```bash
 .
-├── api            # proto文件和生成的*pb.go目录
+├── api            # protobuf文件和生成的*pb.go目录
 ├── assets         # 其他与资源库一起使用的资产(图片、logo等)目录
 ├── cmd            # 程序入口目录
 ├── configs        # 配置文件的目录
-├── deployments    # IaaS、PaaS、系统和容器协调部署的配置和模板目录
+├── deployments    # 裸机、docker、k8s部署脚本目录
 ├── docs           # 设计文档和界面文档目录
-├── internal       # 业务逻辑代码目录，表示私有代码。
+├── internal       # 业务逻辑代码目录
 │    ├── cache        # 基于业务包装的缓存目录
 │    ├── config       # Go结构的配置文件目录
 │    ├── dao          # 数据访问目录
@@ -108,9 +111,32 @@ sponge包含丰富的组件(按需使用)：
 │    ├── service      # grpc的业务功能实现目录
 │    └── types        # http的请求和响应类型目录
 ├── pkg            # 外部应用程序可以使用的库目录
-├── scripts        # 用于执行各种构建、安装、分析等操作的脚本目录
+├── scripts        # 执行脚本目录
 ├── test           # 额外的外部测试程序和测试数据
-└── third_party    # 外部帮助程序、分叉代码和其他第三方工具
+├── third_party    # 依赖第三方protobuf文件或其他工具的目录
+├── Makefile       # 开发、测试、部署相关的命令集合
+├── go.mod         # go 模块依赖关系和版本控制文件
+└── go.sum         # go 模块依赖项的密钥和校验文件
+```
+
+<br>
+
+这是生成的`微服务单体仓库(mono-repo)`代码目录结构(也就是大仓库代码目录结构)：
+
+```bash
+.
+├── api
+│    ├── server1       # 服务1的protobuf文件和生成的*pb.go目录
+│    ├── server2       # 服务2的protobuf文件和生成的*pb.go目录
+│    ├── server3       # 服务3的protobuf文件和生成的*pb.go目录
+│    └── ...
+├── server1        # 服务1的代码目录，与微服务多仓库(multi-repo)目录结构基本一样
+├── server2        # 服务2的代码目录，与微服务多仓库(multi-repo)目录结构基本一样
+├── server3        # 服务3的代码目录，与微服务多仓库(multi-repo)目录结构基本一样
+├── ...
+├── third_party    # 依赖的第三方protobuf文件
+├── go.mod         # go 模块依赖关系和版本控制文件
+└── go.sum         # go 模块依赖项的密钥和校验和文件
 ```
 
 <br>
