docs: update reademe

Author: zhufuyi

README.md

@@ -15,33 +15,44 @@
 
 </div>
 
-**Sponge** is a powerful development framework that integrates `automatic code generation`, `Gin and GRPC`. Sponge has a rich set of code generation commands, and the generated different functional codes can be combined into a complete service (similar to how artificially broken sponge cells can automatically reassemble into a new complete sponge). Sponge provides one-stop project development (code generation, development, testing, api documentation, deployment), it greatly improves development efficiency and reduces development difficulty, develop high-quality projects with a "low code approach".
+**Sponge** is a powerful development framework that integrates `code generation`, `Gin`, and `gRPC`. It offers a rich set of code generation commands, allowing flexible creation of various functional modules that can be combined into complete services (similar to how scattered sponge cells can reorganize into a new sponge). Sponge provides an all-in-one solution for project development, covering code generation, development, testing, API documentation, and deployment, significantly enhancing development efficiency, reducing complexity, and enabling high-quality projects with a "low-code approach".
 
 Sponge is used to quickly and efficiently develop high-performance back-end services for various application scenarios and requirements, including `web` services, `gRPC` services, `http+gRPC` hybrid services, `gRPC gateway API` services.
 
+Sponge not only supports code generation based on Sponge's built-in templates but also allows generating code using custom templates and relevant parameters (e.g., JSON, SQL, Protobuf). Through custom templates, users can generate code required for various projects, without being limited to the Go language.
+
 <br>
 
 ### Sponge Core Design Philosophy
 
-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:
+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 has implemented three core functions:
 
-- 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 protobuf 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 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 (e.g., `mysql`, `mongodb`,`postgresql`,`sqlite`) 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 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.
+- Sponge generates the necessary code for various projects through custom templates and parameters, such as frontend code, backend code, test code, deployment scripts, etc.
 
 <br>
 
 ### Sponge Generates the Code Framework
 
-Sponge generation code is mainly based on `SQL` and `Protobuf` files, where `SQL` supports database **mysql** , **mongodb**, **postgresql**, **tidb**, **sqlite**.
-
 #### Generate Code Framework
 
+The code generation framework based on Sponge's built-in templates is shown below. There are two approaches: SQL and Protobuf.
+
 <p align="center">
 <img width="1500px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/sponge-framework.png">
 </p>
 
 <br>
 
+The code generation framework based on custom templates is shown below. There are three approaches: JSON, SQL, and Protobuf.
+
+<p align="center">
+<img width="1200px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/template-framework.png">
+</p>
+
+<br>
+
 #### Generate Code Framework Corresponding UI Interface
 
 <p align="center">
@@ -52,7 +63,7 @@ Sponge generation code is mainly based on `SQL` and `Protobuf` files, where `SQL
 
 ### Microservice framework
 
-Sponge is also a microservices framework, the framework diagram is shown below, which is a typical microservice hierarchical structure, with high performance, high scalability, contains commonly used service governance features, you can easily replace or add their own service governance features.
+The service code generated by sponge is itself a microservice, the framework diagram is shown below, which is a typical microservice hierarchical structure, with high performance, high scalability, contains commonly used service governance features, you can easily replace or add their own service governance features.
 
 <p align="center">
 <img width="1000px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/microservices-framework.png">
@@ -75,7 +86,6 @@ Click to view the [**test code**](https://github.com/zhufuyi/microservices_frame
 - Web framework [gin](https://github.com/gin-gonic/gin)
 - RPC framework [grpc](https://github.com/grpc/grpc-go)
 - Configuration parsing [viper](https://github.com/spf13/viper)
-- Configuration center [nacos](https://github.com/alibaba/nacos)
 - Logging component [zap](https://github.com/uber-go/zap)
 - Database ORM component [gorm](https://github.com/go-gorm/gorm), [mongo-go-driver](https://github.com/mongodb/mongo-go-driver)
 - Cache component [go-redis](https://github.com/go-redis/redis), [ristretto](https://github.com/dgraph-io/ristretto)
@@ -94,9 +104,11 @@ Click to view the [**test code**](https://github.com/zhufuyi/microservices_frame
 - Service registration and discovery [etcd](https://github.com/etcd-io/etcd), [consul](https://github.com/hashicorp/consul), [nacos](https://github.com/alibaba/nacos)
 - Adaptive collecting [profile](https://go.dev/blog/pprof)
 - Resource statistics [gopsutil](https://github.com/shirou/gopsutil)
+- Configuration center [nacos](https://github.com/alibaba/nacos)
 - Code quality checking [golangci-lint](https://github.com/golangci/golangci-lint)
 - Continuous integration and deployment [jenkins](https://github.com/jenkinsci/jenkins), [docker](https://www.docker.com/), [kubernetes](https://github.com/kubernetes/kubernetes)
 - Generate project business architecture diagram [spograph](https://github.com/zhufuyi/spograph)
+- Custom template generation code [go template](https://pkg.go.dev/text/template@go1.23.3)
 
 <br>
 
@@ -118,6 +130,7 @@ Here is the directory structure for the generated `monolithic application single
 │    ├── cache        # Cache directory wrapped around business logic.
 │    ├── config       # Directory for Go structure configuration files.
 │    ├── dao          # Data access directory.
+│    ├── database     # database directory.
 │    ├── ecode        # Directory for system error codes and custom business error codes.
 │    ├── handler      # Directory for implementing HTTP business functionality (specific to web services).
 │    ├── model        # Database model directory.
@@ -179,7 +192,7 @@ Access `http://localhost:24631` in a local browser and manipulate the generated
 
 ### Sponge Development Documentation
 
-Detailed step-by-step, configuration, deployment instructions for developing projects using sponge, Click here to view the [sponge development documentation](https://go-sponge.com/)
+Click to view [the detailed documentation](https://go-sponge.com/) for Sponge development project, including code generation, development, configuration, and deployment instructions, and more.
 
 <br>
 

assets/en_sponge-ui.png

@@ -2,31 +2,42 @@
 
 <br>
 
-[sponge](https://github.com/zhufuyi/sponge) 是一个集成了 `自动生成代码`、`Gin和GRPC` 的强大的开发框架。sponge拥有丰富的生成代码命令，生成不同的功能代码可以组合成完整的服务(类似人为打散的海绵细胞可以自动重组成一个新的海绵)。sponge提供了一站式项目开发(生成代码、开发、测试、api文档、部署)，大幅提高了开发效率和降低了开发难度，以"低代码方式"开发高质量项目。
+**sponge** 是一个集成了`代码生成`、`Gin` 和 `gRPC` 的强大开发框架，提供丰富的代码生成命令，可灵活生成各类功能模块，并组合成完整的服务(类似打散的海绵细胞能重新组合成新的海绵)。sponge 提供一站式项目开发解决方案，涵盖代码生成、开发、测试、API 文档生成和部署，大幅提升开发效率，降低开发难度，实现以"低代码"方式构建高质量项目。
 
-sponge 用来快速高效开发各种应用场景和需求的高性能后端服务，包括 `web` 服务、`gRPC` 服务、`http+gRPC` 混合服务、 `gRPC网关API`服务等。
+sponge 用来快速开发各种应用场景和需求的高性能后端服务，包括 `web` 服务、`gRPC` 服务、`http+gRPC` 混合服务、 `gRPC网关API`服务等。
+
+sponge 不仅支持基于自带模板生成代码，还支持基于自定义模板和相关参数(如 json、sql、protobuf)生成代码。通过自定义模板，可以生成各类项目所需的代码(不局限于 Go 语言)。
 
 <br>
 
 ### sponge 核心设计理念
 
-sponge 的核心设计理念是通过 `SQL` 或 `Protobuf` 文件逆向生成模块化的代码，这些代码可以灵活、无缝地组合成多种类型的后端服务，从而大大提升开发效率，简化后端服务开发，sponge 的主要目标如下：
+sponge 的核心设计理念是通过 `SQL` 或 `Protobuf` 文件逆向生成模块化的代码，这些代码可以灵活、无缝地组合成多种类型的后端服务，从而大幅大提升开发效率，简化后端服务开发，sponge已实现了三大核心功能：
 
-- 如果开发只有 CRUD api 的 web 或 gRPC 服务，不需要编写任何 go 代码就可以编译并部署到 linux 服务器、docker、k8s 上，只需要连接到数据库就可以一键自动生成完整的后端服务 go 代码。
-- 如果开发通用的 web、gRPC、http+gRPC、gRPC 网关等服务，只需聚焦`在数据库定义表`、`在protobuf文件定义api描述信息`、`在生成的模板文件填写业务逻辑代码`三个核心部分，其他 go 代码(包括CRUD api)都由 sponge 来生成。
+- 如果开发只有 CRUD api 的 web 或 gRPC 服务，不需要编写任何 go 代码就可以编译并部署到 linux 服务器、docker、k8s 上，只需要连接到数据库(例如`mysql`, `mongodb`,`postgresql`,`sqlite`)就可以一键自动生成完整的后端服务 go 代码。
+- 如果开发通用的 web、gRPC、http+gRPC、gRPC 网关等服务，只需聚焦`在数据库定义表`、`在protobuf文件定义api描述信息`、`在生成的模板文件填写业务逻辑代码`这三部分，其他 go 代码(包括CRUD api)都由 sponge 来生成。
+- 通过自定义模板和参数生成各类项目所需的代码，例如前端代码、后端代码、测试代码、部署脚本等。
 
 <br>
 
 #### 生成代码的框架图
 
-sponge 生成代码主要基于 `SQL` 和 `Protobuf`文件，其中 `SQL` 支持数据库 **mysql**、**mongodb**、**postgresql**、**tidb**、**sqlite**。
+sponge 基于自带模板生成代码框架如下图所示，共有 sql 和 protobuf 两种方式生成代码。
 
 <p align="center">
 <img width="1500px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/sponge-framework.png">
 </p>
 
 <br>
 
+sponge 基于自定义模板生成代码框架如下图所示，共有 json、sql、protobuf 三种方式生成代码。
+
+<p align="center">
+<img width="1200px" src="https://raw.githubusercontent.com/zhufuyi/sponge/main/assets/template-framework.png">
+</p>
+
+<br>
+
 #### 生成代码框架对应的UI界面
 
 <p align="center">
@@ -62,7 +73,6 @@ sponge包含丰富的组件(按需使用)：
 - Web 框架 [gin](https://github.com/gin-gonic/gin)
 - RPC 框架 [grpc](https://github.com/grpc/grpc-go)
 - 配置解析 [viper](https://github.com/spf13/viper)
-- 配置中心 [nacos](https://github.com/alibaba/nacos)
 - 日志 [zap](https://github.com/uber-go/zap)
 - 数据库组件 [gorm](https://github.com/go-gorm/gorm), [mongo-go-driver](https://github.com/mongodb/mongo-go-driver)
 - 缓存组件 [go-redis](https://github.com/go-redis/redis), [ristretto](https://github.com/dgraph-io/ristretto)
@@ -81,9 +91,11 @@ sponge包含丰富的组件(按需使用)：
 - 服务注册与发现 [etcd](https://github.com/etcd-io/etcd), [consul](https://github.com/hashicorp/consul), [nacos](https://github.com/alibaba/nacos)
 - 自适应采集 [profile](https://go.dev/blog/pprof)
 - 资源统计 [gopsutil](https://github.com/shirou/gopsutil)
+- 配置中心 [nacos](https://github.com/alibaba/nacos)
 - 代码质量检查 [golangci-lint](https://github.com/golangci/golangci-lint)
 - 持续集成部署 CICD [jenkins](https://github.com/jenkinsci/jenkins), [docker](https://www.docker.com/), [kubernetes](https://github.com/kubernetes/kubernetes)
 - 生成项目业务架构图 [spograph](https://github.com/zhufuyi/spograph)
+- 自定义模板生成代码 [go template](https://pkg.go.dev/text/template@go1.23.3)
 
 <br>
 
@@ -105,6 +117,7 @@ sponge包含丰富的组件(按需使用)：
 │    ├── cache        # 基于业务包装的缓存目录
 │    ├── config       # Go结构的配置文件目录
 │    ├── dao          # 数据访问目录
+│    ├── database     # 数据库目录
 │    ├── ecode        # 自定义业务错误代码目录
 │    ├── handler      # http的业务功能实现目录
 │    ├── model        # 数据库模型目录
@@ -146,7 +159,7 @@ sponge包含丰富的组件(按需使用)：
 
 ### 快速开始
 
-#### 安装sponge
+#### 安装 sponge
 
 支持在windows、mac、linux环境下安装sponge，点击查看[安装sponge说明](https://github.com/zhufuyi/sponge/blob/main/assets/install-cn.md)。
 
@@ -164,15 +177,15 @@ sponge run
 
 <br>
 
-### sponge开发文档
+### sponge 开发文档
 
-使用sponge开发项目的详细的步骤、配置、部署说明，点击查看[sponge开发文档](https://go-sponge.com/zh-cn/)。
+点击查看 [sponge 开发项目的详细文档](https://go-sponge.com/zh-cn/)，包括代码生成、开发、配置、部署说明等。
 
 <br>
 
 ### 使用示例
 
-#### 使用sponge创建服务示例
+#### 使用 sponge 创建服务示例
 
 - [基于sql创建web服务(包括CRUD)](https://github.com/zhufuyi/sponge_examples/tree/main/1_web-gin-CRUD)
 - [基于sql创建grpc服务(包括CRUD)](https://github.com/zhufuyi/sponge_examples/tree/main/2_micro-grpc-CRUD)
@@ -181,7 +194,7 @@ sponge run
 - [基于protobuf创建grpc网关服务](https://github.com/zhufuyi/sponge_examples/tree/main/5_micro-gin-rpc-gateway)
 - [基于protobuf创建grpc+http服务](https://github.com/zhufuyi/sponge_examples/tree/main/_10_micro-grpc-http-protobuf)
 
-#### 使用sponge开发完整项目示例
+#### 使用 sponge 开发完整项目示例
 
 - [简单的社区web后端服务](https://github.com/zhufuyi/sponge_examples/tree/main/7_community-single)
 - [简单的社区web后端服务拆分为微服务](https://github.com/zhufuyi/sponge_examples/tree/main/8_community-cluster)

assets/readme-cn.md

@@ -1,2 +1,2 @@
-<!DOCTYPE html><html><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>Sponge Generate Code</title><link rel=icon type=image/png sizes=32x32 href="/static/favicon.png?v=1.0"><script type=text/javascript src=/static/appConfig.js async></script><link href=/static/css/app.d86d99ed9313579ae97df6cbaf372030.css rel=stylesheet></head><body style="margin: 0px; padding: 0px;"><style>.el-tooltip__popper {box-shadow: 3px 3px 10px 5px #d3d3d6;border-width: 0px !important;}
-      .el-tooltip__popper[x-placement^="top"] .popper__arrow:after {border-top-color: #dcdfe6 !important;}</style><div id=app></div><script type=text/javascript src=/static/js/manifest.2ae2e69a05c33dfc65f8.js></script><script type=text/javascript src=/static/js/vendor.d8cdb3748af43d2ae51a.js></script><script type=text/javascript src=/static/js/app.eb5d32169a92e7e955d4.js></script></body></html>
+<!DOCTYPE html><html><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>Sponge Generate Code</title><link rel=icon type=image/png sizes=32x32 href="/static/favicon.png?v=1.0"><script type=text/javascript src=/static/appConfig.js async></script><link href=/static/css/app.2fadb537257f44b2192f8ffe1ce19370.css rel=stylesheet></head><body style="margin: 0px; padding: 0px;"><style>.el-tooltip__popper {box-shadow: 3px 3px 10px 5px #d3d3d6;border-width: 0px !important;}
+      .el-tooltip__popper[x-placement^="top"] .popper__arrow:after {border-top-color: #dcdfe6 !important;}</style><div id=app></div><script type=text/javascript src=/static/js/manifest.2ae2e69a05c33dfc65f8.js></script><script type=text/javascript src=/static/js/vendor.d8cdb3748af43d2ae51a.js></script><script type=text/javascript src=/static/js/app.673ef5316b942a28ecac.js></script></body></html>