Skip to content

Commit fd4da15

Browse files
committed
docs: update Documentation
1 parent 7c49a68 commit fd4da15

File tree

2 files changed

+24
-14
lines changed

2 files changed

+24
-14
lines changed

.github/RELEASE.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,43 @@
44
1. **Customizable Primary Keys for SQL Tables**:
55
- Primary key names are no longer restricted to `id`, and the type is no longer limited to integers. Other names and string types are now supported.
66

7-
2. **Enhanced Protobuf Support**:
8-
- Added a `protoc` plugin for converting Protobuf to JSON.
9-
10-
3. **Improved Code Generation**:
7+
2. **Improved Code Generation**:
118
- Added a command for generating code based on custom templates and fields.
129
- Added a command for generating code based on custom templates and SQL.
1310
- Added a command for generating code based on custom templates and Protobuf.
11+
- Added a `protoc` plugin for converting Protobuf to JSON.
1412
- Introduced a web interface for generating code using custom templates.
1513

1614
### **Framework and Code Enhancements**
1715

18-
4. **Simplified service code generation**:
16+
3. **Simplified service code generation**:
1917
- Removed default code blocks for service registration and discovery and Nacos configuration center. If needed, users can add them manually.
2018

21-
5. **Directory Structure Optimization**:
19+
4. **Directory Structure Optimization**:
2220
- Moved `internal/model/init.go` to the `internal/database` directory.
2321

24-
6. **Simplified Dependencies**:
22+
5. **Simplified Dependencies**:
2523
- Replaced `pkg/ggorm` with `pkg/sgorm`, reducing code dependencies during compilation.
2624
- Delete dropped library `pkg/mysql`
2725

2826
### **New Commands and Tools**
2927

30-
7. **Command Enhancements**:
28+
6. **Command Enhancements**:
3129
- The `make proto` command now automatically initializes the database and imports dependencies from `types.proto`.
3230

31+
7. **Simplified command**:
32+
- Merge `sponge configmap` into `sponge config` and rename it `cm`, see the help `sponge config cm -h`.
33+
3334
8. **Architecture Diagram Generation**:
3435
- Automatically generates project business architecture diagrams based on service configurations. e.g. https://github.com/zhufuyi/spograph/blob/main/example.png
3536

37+
### **Upgrade Dependency Library Version**
38+
39+
- google.golang.org/grpc: `v1.61.0` --> `v1.67.1`
40+
- github.com/grpc-ecosystem/go-grpc-middleware: `v1.3.0` --> `v2.1.0`
41+
- github.com/redis/go-redis/v9: `v9.6.1` --> `v9.7.0`
42+
- go.etcd.io/etcd/client/v3: `v3.5.4` --> `v3.5.13`
43+
3644
### **Bug Fixes**
3745

3846
- [#78](https://github.com/zhufuyi/sponge/issues/78)

doc.go

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
// Package sponge is a powerful Go development framework, it's easy to develop web and microservice projects.
2-
// repo: https://github.com/zhufuyi/sponge
3-
// docs: https://go-sponge.com
1+
// Package sponge is a powerful Go development framework that makes it easy to develop web, gRPC, and microservices projects, while supporting custom templates to generate code for various projects.
2+
// ```
3+
// Github: https://github.com/zhufuyi/sponge
4+
// Documentation: https://go-sponge.com
45
//
56
// Usage:
67
// sponge [command]
78
//
89
// Available Commands:
910
// completion Generate the autocompletion script for the specified shell
1011
// config Generate go config code from yaml file
11-
// configmap Generate k8s configmap
1212
// help Help about any command
1313
// init Initialize sponge
1414
// merge Merge the generated code into the template file
1515
// micro Generate protobuf, model, cache, dao, service, grpc, grpc+http, grpc-gw, grpc-cli code
16-
// patch Command set for patching service code
16+
// patch Patch the generated code
1717
// plugins Managing sponge dependency plugins
18-
// run Run the sponge ui service
18+
// run Run code generation UI service
19+
// template Generate code based on custom templates
1920
// upgrade Upgrade sponge version
2021
// web Generate model, cache, dao, handler, http code
2122
//
@@ -24,4 +25,5 @@
2425
// -v, --version version for sponge
2526
//
2627
// Use "sponge [command] --help" for more information about a command.
28+
// ```
2729
package sponge

0 commit comments

Comments
 (0)