Skip to content

Commit ca32dbb

Browse files
committed
docs: update README
1 parent af78f18 commit ca32dbb

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Sponge provides a one-stop project development solution, covering code generatio
2828
- **Standardized Best Practices**: Based on mature solutions from the Go community (Gin/gRPC/Protobuf, etc.), eliminating the hassle of technology selection.
2929
- **Minimal Learning Curve**: Get started quickly and focus on business logic through code generation and clear examples.
3030
- **Ideal for Team Collaboration**: Unified project structure improves code maintainability.
31-
- **AI Collaboration**: Based on Sponge's standardized directory and file structure, it intelligently generates business logic code, significantly reducing manual coding and improving development efficiency and code consistency.
31+
- **AI Collaborative Development**: Sponge’s built-in AI assistant understands directory and file structures, intelligently generates business logic code based on context, significantly reduces manual coding, and improves development efficiency and code consistency.
3232

3333
<br>
3434

@@ -113,11 +113,12 @@ Sponge provides an online experience for code generation: [**Code Generation**](
113113
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_sponge-ui.png">
114114
</p>
115115

116-
- Connect to the database, select table names.
117-
- Download Code: Get the complete code.
118-
- Generate Swagger Docs: `make docs`.
119-
- Run: `make run`.
120-
- Test: Access the Swagger documentation at `http://localhost:8080/swagger/index.html` in your browser to test the API.
116+
- Steps for running and testing the project locally:
117+
- **Fill in parameters**: Connect to the database and select the table name.
118+
- **Download code**: Obtain the complete project code.
119+
- **Generate Swagger documentation**: Run the command `make docs`.
120+
- **Start the service**: Run the command `make run`.
121+
- **API testing**: Open `http://localhost:8080/swagger/index.html` in the browser and use the Swagger UI to test APIs.
121122

122123
<br>
123124

assets/en_sponge-ui.png

7.63 KB
Loading

assets/readme-cn.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Sponge 提供一站式项目开发解决方案,涵盖代码生成、开发、
1515
- **标准化最佳实践**:基于 Go 社区成熟方案(Gin/gRPC/Protobuf 等),避免技术选型纠结。
1616
- **极简学习曲线**:通过代码生成和清晰示例,快速上手,专注业务逻辑。
1717
- **适合团队协作**:统一项目结构,提升代码可维护性。
18-
- **AI协作**基于 Sponge 规范目录与文件结构,智能生成业务逻辑代码,显著降低手工编码,提升开发效率与代码一致性。
18+
- **AI 协作开发**:Sponge 内置 AI 助手感知目录与文件结构,根据上下文智能生成业务逻辑代码,显著降低手工编码,提升开发效率与代码一致性。
1919

2020
<br>
2121

@@ -101,11 +101,12 @@ Sponge 提供在线体验生成代码:[**Code Generation**](https://go-sponge.
101101
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-ui.png">
102102
</p>
103103

104-
- 连接数据库,选择表名。
105-
- 下载代码:得到完整代码。
106-
- 生成 swagger 文档:`make docs`
107-
- 运行:`make run`
108-
- 测试:在浏览器访问 swagger 文档 `http://localhost:8080/swagger/index.html` 测试 API。
104+
- 项目本地运行与测试步骤:
105+
- **填写参数**:连接数据库,选择表名。
106+
- **下载代码**:获取完整项目代码。
107+
- **生成 swagger 文档**:执行命令 `make docs`
108+
- **启动服务**:执行命令 `make run`
109+
- **接口测试**:在浏览器中访问 `http://localhost:8080/swagger/index.html` 通过 Swagger 界面进行 API 测试。
109110

110111
<br>
111112

assets/sponge-ui.png

5.06 KB
Loading

0 commit comments

Comments
 (0)