update docs

Author: zhufuyi

cmd/sponge/commands/micro.go

@@ -10,8 +10,8 @@ import (
 func GenMicroCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:           "micro",
-		Short:         "Generate proto, model, cache, dao, service, grpc, grpc+http, grpc-gw, grpc-cli code",
-		Long:          "generate proto, model, cache, dao, service, grpc, grpc+http, grpc-gw, grpc-cli code.",
+		Short:         "Generate protobuf, model, cache, dao, service, grpc, grpc-gw, grpc+http, grpc-cli code",
+		Long:          "generate protobuf, model, cache, dao, service, grpc, grpc-gw, grpc+http, grpc-cli code.",
 		SilenceErrors: true,
 		SilenceUsage:  true,
 	}

cmd/sponge/commands/patch.go

@@ -10,8 +10,8 @@ import (
 func PatchCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:           "patch",
-		Short:         "Command set for patching server code",
-		Long:          `command set for patching server code.`,
+		Short:         "Command set for patching service code",
+		Long:          `command set for patching service code.`,
 		SilenceErrors: true,
 		SilenceUsage:  true,
 	}

cmd/sponge/commands/patch/copy-proto.go

@@ -1,4 +1,4 @@
-// Package patch is command set for patching server code.
+// Package patch is command set for patching service code.
 package patch
 
 import (

cmd/sponge/commands/web.go

@@ -10,8 +10,8 @@ import (
 func GenWebCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:           "web",
-		Short:         "Generate model, cache, dao, handler, web code",
-		Long:          "generate model, cache, dao, handler, web code.",
+		Short:         "Generate model, cache, dao, handler, http code",
+		Long:          "generate model, cache, dao, handler, http code.",
 		SilenceErrors: true,
 		SilenceUsage:  true,
 	}

doc.go

@@ -1,28 +1,27 @@
-// Package sponge is a powerful tool for generating web and microservice code, a microservice framework
-// based on gin and grpc encapsulation, and an open source framework for rapid application development.
+// 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
 //
 // Usage:
-//
-//	sponge [command]
+// sponge [command]
 //
 // Available Commands:
-//
-//	completion    Generate the autocompletion script for the specified shell
-//	config        Generate go config code from yaml file
-//	help          Help about any command
-//	init          Initialize sponge
-//	merge         Merge the generated code into the template file
-//	micro         Generate proto, model, cache, dao, service, rpc, rpc-gw, rpc-cli code
-//	patch         Command set for patching server code
-//	run           Open the sponge UI interface
-//	tools         Managing sponge dependency tools
-//	upgrade       Upgrade sponge to the latest version
-//	web           Generate model, cache, dao, handler, web code
+// 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
+// plugins     Managing sponge dependency plugins
+// run         Open the sponge UI interface
+// upgrade     Upgrade sponge version
+// web         Generate model, cache, dao, handler, http code
 //
 // Flags:
-//
-//	-h, --help      help for sponge
-//	-v, --version   version for sponge
+// -h, --help      help for sponge
+// -v, --version   version for sponge
 //
 // Use "sponge [command] --help" for more information about a command.
 package sponge