Skip to content

Commit e2a6638

Browse files
committed
docs: update README
1 parent f74a361 commit e2a6638

File tree

3 files changed

+45
-61
lines changed

3 files changed

+45
-61
lines changed

.github/RELEASE.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,4 @@
11

22
## Changelog
33

4-
### 1. **Enhanced TLS Encryption Support**
5-
6-
The web service now supports multiple TLS encryption methods, including automatic certificate generation, manual certificate upload, Let's Encrypt auto-renewal, and dynamic certificate retrieval via remote APIs. Additionally, it features extensible architecture for dynamically obtaining certificates from configuration centers like etcd and Consul.
7-
8-
### 2. **Route Reverse Proxy Capability**
9-
10-
The web services support reverse proxy capabilities similar to Nginx, supporting flexible route configuration and request forwarding.
11-
12-
### 3. **Static Resource Serving**
13-
14-
Efficient serving of static files and web pages through route mapping, enabling one-stop hosting for frontend resources.
15-
16-
### 4. **Customizable CORS Middleware**
17-
18-
CORS middleware now supports fully customizable configurations to meet diverse cross-origin access requirements.
19-
20-
### 5. **Bug Fix**
21-
22-
Resolved PostgreSQL `timestamptz` type mapping issue [#141](https://github.com/go-dev-frame/sponge/issues/141).
4+
- Fix the issue of error when the parameter `sort` value of the custom query API interface is set to `ignore count`.

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717

1818
---
1919

20-
<br>
21-
2220
### Introduction
2321

2422
**Sponge** is a powerful and easy-to-use **Go development framework**. Built on the core philosophy of **"Definition is Code"**, it aims to reshape the backend development experience through automatic generation technology, unleashing productivity and boosting development efficiency.
@@ -27,20 +25,20 @@ Sponge deeply integrates a **code generation engine**, **Gin (Web framework)**,
2725

2826
**Core Features:**
2927

30-
* **Definition-Driven Development**: Automatically parses SQL, Protobuf, and JSON configuration files to generate high-quality modular code.
31-
* **LEGO-style Assembly**: Flexibly combines code modules in a loosely coupled manner, supporting the rapid construction of **monolithic applications**, **microservice clusters**, and **gateway services**, including `RESTful API`, `gRPC`, `HTTP+gRPC`, `gRPC Gateway`, etc.
32-
* **Low Code, High Efficiency**: Completely eliminates tedious repetitive work such as CRUD, routing configuration, and service governance. Developers only need to focus on core business logic to deliver standardized, high-quality backend services.
28+
- **Definition-Driven Development**: Automatically parses SQL, Protobuf, and JSON configuration files to generate high-quality modular code.
29+
- **LEGO-style Assembly**: Flexibly combines code modules in a loosely coupled manner, supporting the rapid construction of **monolithic applications**, **microservice clusters**, and **gateway services**, including `RESTful API`, `gRPC`, `HTTP+gRPC`, `gRPC Gateway`, etc.
30+
- **Low Code, High Efficiency**: Eliminate the tedious, repetitive tasks of building underlying frameworks, developing CRUD operations, and configuring routing and governance. This allows developers to focus solely on core business logic and rapidly deliver standardized, high-quality backend services.
3331

3432
<br>
3533

3634
### Why Choose Sponge?
3735

38-
- **Extreme Development Efficiency**: One-click generation of complete, production-ready backend services (Zero-Code), including CRUD, routing, documentation, and service framework code, multiplying development efficiency.
36+
- **Extreme Development Efficiency**: One-click generation of complete, production-ready backend services, including CRUD, routing, documentation, and service framework code, multiplying development efficiency.
3937
- **Out-of-the-box Toolchain**: Provides a complete development toolchain (Generation → Business Logic → Testing → Deployment → Monitoring), eliminating the need to piece together fragmented tools.
4038
- **Industry Best Practices**: Built on the mainstream Go community tech stack (Gin/GORM/gRPC/Protobuf, etc.), with a standardized architecture to reduce technology selection risks.
4139
- **Extremely Low Learning Curve**: Easy to get started and beginner-friendly, while also meeting the customization needs of senior developers.
4240
- **Ideal for Team Collaboration**: Unifies project structure, improving team collaboration efficiency and code maintainability.
43-
* **Flexible and Extensible**: Supports custom templates, not limited to Go; capable of extending to frontend, test scripts, and other arbitrary code generation.
41+
- **Flexible and Extensible**: Supports custom templates, not limited to Go; capable of extending to frontend, test scripts, and other arbitrary code generation.
4442
- **AI-Driven Development (AI-Native)**:
4543
- **Sponge:** automatically builds standardized infrastructure (API, data layer, service framework).
4644
- **AI Assistant:** analyzes project context and generates code intelligently fill in core business logic based on project context, achieving "Infrastructure Automation, Business Intelligence".
@@ -51,11 +49,11 @@ Sponge deeply integrates a **code generation engine**, **Gin (Web framework)**,
5149

5250
Sponge is suitable for building high-performance, maintainable backend systems, specifically for:
5351

54-
- **Rapid development of RESTful API services.**
55-
- **Building large-scale microservice architectures.**
56-
- **Cloud-native application development.**
57-
- **Rapid refactoring and migration of legacy projects.**
58-
- **Standardized engineering templates for Go beginners or teams.**
52+
- Rapid development of RESTful API services.
53+
- Building large-scale microservice architectures.
54+
- Cloud-native application development.
55+
- Rapid refactoring and migration of legacy projects.
56+
- Standardized engineering templates for Go beginners or teams.
5957

6058
<br>
6159

@@ -82,7 +80,7 @@ No installation required, experience the code generation feature directly in you
8280
3. **Example: One-click Generation of Web Service Backend Code Based on SQL**
8381

8482
<p align="center">
85-
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_sponge-ui.png">
83+
<img width="750px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_sponge-ui.png">
8684
</p>
8785

8886
- Operation Process:
@@ -120,33 +118,33 @@ Sponge provides multiple code generation engines, supporting **built-in template
120118
1. Code generation engine based on **built-in templates**, as shown below:
121119

122120
<p align="center">
123-
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-framework.png">
121+
<img width="1200px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-framework.png">
124122
</p>
125123

126124
<br>
127125

128126
2. Code generation engine based on **custom templates**, as shown below:
129127

130128
<p align="center">
131-
<img width="1200px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/template-framework.png">
129+
<img width="600px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/template-framework.png">
132130
</p>
133131

134132
<br>
135133

136134
3. Code generation engine based on **AI-assisted business logic**, as shown below:
137135

138136
<p align="center">
139-
<img width="1200px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/ai-assistant-framework.png">
137+
<img width="600px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/ai-assistant-framework.png">
140138
</p>
141139

142140
<br>
143141

144142
#### Microservice Architecture
145143

146-
The code generated by Sponge follows a typical layered architecture with built-in service governance capabilities. The structure is clear and easy to maintain. A modern microservice framework structure is shown below:
144+
The code generated by Sponge follows a typical layered architecture with built-in service governance capabilities. The structure is clear and easy to maintain. The microservice framework structure of Sponge is shown below:
147145

148146
<p align="center">
149-
<img width="1000px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_microservices-framework.png">
147+
<img width="750px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_microservices-framework.png">
150148
</p>
151149

152150
<br>
@@ -156,10 +154,14 @@ The code generated by Sponge follows a typical layered architecture with built-i
156154
Based on tests with 50 concurrency and 1 million requests, services generated by Sponge demonstrate excellent performance:
157155

158156
1. **HTTP Service**
159-
![http-server](https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/http-server.png)
157+
<p align="center">
158+
<img width="900px" src="https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/http-server.png">
159+
</p>
160160

161161
2. **gRPC Service**
162-
![grpc-server](https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/grpc-server.png)
162+
<p align="center">
163+
<img width="900px" src="https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/grpc-server.png">
164+
</p>
163165

164166
👉 [**View detailed test code and environment**](https://github.com/zhufuyi/microservices_framework_benchmark).
165167

assets/readme-cn.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
## [English](../README.md) | 简体中文
22

3-
---
4-
5-
<br>
6-
73
### 简介
84

95
**Sponge** 是一款强大且易用的 **Go 开发框架**。它基于 **"Definition is Code" (定义即代码)** 的核心理念,致力于通过自动生成技术重塑后端开发体验,解放生产力,大幅提升开发效率。
@@ -12,20 +8,20 @@ Sponge 深度集成了 **代码生成引擎**、 **Gin (Web 框架)** 与 **gRPC
128

139
**核心特性:**
1410

15-
* **定义驱动开发**:自动解析 SQL、Protobuf 和 JSON 配置文件,生成高质量的模块化代码。
16-
* **积木式组装**:以松耦合的方式灵活组合代码模块,支持快速构建 **单体应用****微服务集群****网关服务**,包括 `RESTful API``gRPC``HTTP+gRPC``gRPC Gateway` 等。
17-
* **低代码,高效率**彻底消除 CRUD、路由配置、服务治理等繁琐的重复性工作。开发者只需专注于核心业务逻辑,即可交付标准化、高质量的后端服务。
11+
- **定义驱动开发**:自动解析 SQL、Protobuf 和 JSON 配置文件,生成高质量的模块化代码。
12+
- **积木式组装**:以松耦合的方式灵活组合代码模块,支持快速构建 **单体应用****微服务集群****网关服务**,包括 `RESTful API``gRPC``HTTP+gRPC``gRPC Gateway` 等。
13+
- **低代码,高效率**彻底消除从底层框架搭建、CRUD开发到路由配置、服务治理等一系列繁琐的重复性工作。开发者只需专注于核心业务逻辑,即可快速交付标准化、高质量的后端服务。
1814

1915
<br>
2016

2117
### 为什么选择 Sponge?
2218

23-
- **极致的开发效率**:一键生成可直接线上部署的完整后端服务 (Zero-Code),包括 CRUD、路由、文档及服务框架代码等,开发效率成倍提升。
19+
- **极致的开发效率**:一键生成可直接线上部署的完整后端服务,包括 CRUD、路由、文档及服务框架代码等,开发效率成倍提升。
2420
- **开箱即用的工具链**:提供完整的开发工具链(生成 → 填充业务 → 测试 → 部署 → 监控),无需拼凑碎片化工具。
2521
- **行业最佳实践**:基于 Go 社区主流技术栈(Gin/GORM/gRPC/Protobuf 等)构建,架构规范,降低技术选型风险。
2622
- **极低的学习门槛**:上手简单,对新手友好,同时满足资深开发者的定制需求。
2723
- **适合团队协作**:统一项目结构,提升团队协作效率和代码可维护性。
28-
* **灵活可扩展**:支持自定义模板,不仅限于 Go,还可扩展前端、测试脚本等任意代码生成。
24+
- **灵活可扩展**:支持自定义模板,不仅限于 Go,还可扩展前端、测试脚本等任意代码生成。
2925
- **AI 驱动开发 (AI-Native)**
3026
- **Sponge:** 自动构建标准化的基础设施(API、数据层、服务框架)。
3127
- **AI 助手:** 基于项目上下文,智能填充核心业务逻辑,实现“基建自动化,业务智能化”。
@@ -36,11 +32,11 @@ Sponge 深度集成了 **代码生成引擎**、 **Gin (Web 框架)** 与 **gRPC
3632

3733
Sponge 适用于构建高性能、可维护的后端系统,特别适合:
3834

39-
- **快速开发 RESTful API 服务。**
40-
- **构建大规模微服务架构。**
41-
- **云原生应用开发。**
42-
- **旧有项目的快速重构与迁移。**
43-
- **Go 语言初学者或团队的标准化工程模板。**
35+
- 快速开发 RESTful API 服务。
36+
- 构建大规模微服务架构。
37+
- 云原生应用开发。
38+
- 旧有项目的快速重构与迁移。
39+
- Go 语言初学者或团队的标准化工程模板。
4440

4541
<br>
4642

@@ -67,7 +63,7 @@ Sponge 适用于构建高性能、可维护的后端系统,特别适合:
6763
3. **示例:基于 SQL 一键生成 Web 服务后端代码**
6864

6965
<p align="center">
70-
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-ui.png">
66+
<img width="750px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-ui.png">
7167
</p>
7268

7369
- 操作流程:
@@ -105,33 +101,33 @@ Sponge 提供多种代码生成引擎,支持**内置模板**、**自定义模
105101
1. 基于**内置模板**的代码生成引擎,如下图所示:
106102

107103
<p align="center">
108-
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-framework.png">
104+
<img width="1200px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-framework.png">
109105
</p>
110106

111107
<br>
112108

113109
2. 基于**自定义模板**代码生成引擎,如下图所示:
114110

115111
<p align="center">
116-
<img width="1200px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/template-framework.png">
112+
<img width="600px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/template-framework.png">
117113
</p>
118114

119115
<br>
120116

121117
3. **AI 辅助业务逻辑**代码生成引擎,如下图所示:
122118

123119
<p align="center">
124-
<img width="1200px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/ai-assistant-framework.png">
120+
<img width="600px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/ai-assistant-framework.png">
125121
</p>
126122

127123
<br>
128124

129125
#### 微服务架构
130126

131-
Sponge 生成的代码遵循典型的分层架构,内置服务治理能力,结构清晰,易于维护。一个现代的微服务框架结构如下图所示
127+
Sponge 生成的代码遵循典型的分层架构,内置服务治理能力,结构清晰,易于维护。Sponge 的微服务框架结构如下图所示
132128

133129
<p align="center">
134-
<img width="1000px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/microservices-framework.png">
130+
<img width="750px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/microservices-framework.png">
135131
</p>
136132

137133
<br>
@@ -141,10 +137,14 @@ Sponge 生成的代码遵循典型的分层架构,内置服务治理能力,
141137
基于 50 并发、100 万次请求的测试结果显示,Sponge 生成的服务具有优异的性能表现:
142138

143139
1. **HTTP 服务**
144-
![http-server](https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/http-server.png)
140+
<p align="center">
141+
<img width="900px" src="https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/http-server.png">
142+
</p>
145143

146144
2. **gRPC 服务**
147-
![grpc-server](https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/grpc-server.png)
145+
<p align="center">
146+
<img width="900px" src="https://raw.githubusercontent.com/zhufuyi/microservices_framework_benchmark/main/test/assets/grpc-server.png">
147+
</p>
148148

149149
👉 [**查看详细测试代码与环境**](https://github.com/zhufuyi/microservices_framework_benchmark)
150150

0 commit comments

Comments
 (0)