docs: update Documentation

.github/RELEASE.md

@@ -4,35 +4,43 @@
 1. **Customizable Primary Keys for SQL Tables**:
     - 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.
 
-2. **Enhanced Protobuf Support**:
-    - Added a `protoc` plugin for converting Protobuf to JSON.
-
-3. **Improved Code Generation**:
+2. **Improved Code Generation**:
     - Added a command for generating code based on custom templates and fields.
     - Added a command for generating code based on custom templates and SQL.
     - Added a command for generating code based on custom templates and Protobuf.
+    - Added a `protoc` plugin for converting Protobuf to JSON.
     - Introduced a web interface for generating code using custom templates.
 
 ### **Framework and Code Enhancements**
 
-4. **Simplified service code generation**:
+3. **Simplified service code generation**:
     - Removed default code blocks for service registration and discovery and Nacos configuration center. If needed, users can add them manually.
 
-5. **Directory Structure Optimization**:
+4. **Directory Structure Optimization**:
     - Moved `internal/model/init.go` to the `internal/database` directory.
 
-6. **Simplified Dependencies**:
+5. **Simplified Dependencies**:
     - Replaced `pkg/ggorm` with `pkg/sgorm`, reducing code dependencies during compilation.
     - Delete dropped library `pkg/mysql`
 
 ### **New Commands and Tools**
 
-7. **Command Enhancements**:
+6. **Command Enhancements**:
     - The `make proto` command now automatically initializes the database and imports dependencies from `types.proto`.
 
+7. **Simplified command**:
+    - Merge `sponge configmap` into `sponge config` and rename it `cm`, see the help `sponge config cm -h`.
+
 8. **Architecture Diagram Generation**:
     - Automatically generates project business architecture diagrams based on service configurations. e.g. https://github.com/zhufuyi/spograph/blob/main/example.png
 
+### **Upgrade Dependency Library Version**
+
+- google.golang.org/grpc: `v1.61.0` --> `v1.67.1`
+- github.com/grpc-ecosystem/go-grpc-middleware: `v1.3.0` --> `v2.1.0`
+- github.com/redis/go-redis/v9: `v9.6.1` --> `v9.7.0`
+- go.etcd.io/etcd/client/v3: `v3.5.4` --> `v3.5.13`
+
 ### **Bug Fixes**
 
 - [#78](https://github.com/zhufuyi/sponge/issues/78)

doc.go

@@ -1,21 +1,22 @@
-// Package sponge  is a powerful Go development framework, it's easy to develop web and microservice projects.
-// repo: https://github.com/zhufuyi/sponge
-// docs: https://go-sponge.com
+// 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.
+// ```
+// Github: https://github.com/zhufuyi/sponge
+// Documentation: https://go-sponge.com
 //
 // Usage:
 // sponge [command]
 //
 // Available Commands:
 // completion  Generate the autocompletion script for the specified shell
 // config      Generate go config code from yaml file
-// configmap   Generate k8s configmap
 // help        Help about any command
 // init        Initialize sponge
 // merge       Merge the generated code into the template file
 // micro       Generate protobuf, model, cache, dao, service, grpc, grpc+http, grpc-gw, grpc-cli code
-// patch       Command set for patching service code
+// patch       Patch the generated code
 // plugins     Managing sponge dependency plugins
-// run         Run the sponge ui service
+// run         Run code generation UI service
+// template    Generate code based on custom templates
 // upgrade     Upgrade sponge version
 // web         Generate model, cache, dao, handler, http code
 //
@@ -24,4 +25,5 @@
 // -v, --version   version for sponge
 //
 // Use "sponge [command] --help" for more information about a command.
+// ```
 package sponge