docs:optimize readme (#4)

kitex-contrib · Nov 23, 2023 · f07bbd5 · f07bbd5
1 parent 4ac6aec
commit f07bbd5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -38,8 +38,7 @@ func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Respon
 }
 
 func main() {
-	klog.SetLevel(klog.LevelDebug)
-	serviceName := "ServiceName"
+	serviceName := "ServiceName"// your server-side service name
 	etcdClient, err := etcd.NewClient(etcd.Options{})
 	if err!=nil {
 		panic(err)
@@ -87,17 +86,15 @@ func (cl *configLog) Apply(opt *utils.Options) {
 }
 
 func main() {
-	klog.SetLevel(klog.LevelDebug)
-
 	etcdClient, err := etcd.NewClient(etcd.Options{})
 	if err != nil {
 		panic(err)
 	}
 
 	cl := &configLog{}
 
-	serviceName := "ServiceName"
-	clientName := "ClientName"
+	serviceName := "ServiceName"// your server-side service name
+	clientName := "ClientName"// your client-side service name
 	client, err := echo.NewClient(
 		serviceName,
 		client.WithHostPorts("0.0.0.0:8888"),

diff --git a/README_CN.md b/README_CN.md
@@ -38,8 +38,7 @@ func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Respon
 }
 
 func main() {
-	klog.SetLevel(klog.LevelDebug)
-	serviceName := "ServiceName"
+	serviceName := "ServiceName"// your server-side service name
 	etcdClient, err := etcd.NewClient(etcd.Options{})
 	if err!=nil {
 		panic(err)
@@ -87,17 +86,15 @@ func (cl *configLog) Apply(opt *utils.Options) {
 }
 
 func main() {
-	klog.SetLevel(klog.LevelDebug)
-
 	etcdClient, err := etcd.NewClient(etcd.Options{})
 	if err != nil {
 		panic(err)
 	}
 
 	cl := &configLog{}
 
-	serviceName := "ServiceName"
-	clientName := "ClientName"
+	serviceName := "ServiceName"// your server-side service name
+	clientName := "ClientName"// your client-side service name
 	client, err := echo.NewClient(
 		serviceName,
 		client.WithHostPorts("0.0.0.0:8888"),

diff --git a/example/client/main.go b/example/client/main.go
@@ -38,17 +38,15 @@ func (cl *configLog) Apply(opt *utils.Options) {
 }
 
 func main() {
-	klog.SetLevel(klog.LevelDebug)
-
 	etcdClient, err := etcd.NewClient(etcd.Options{})
 	if err != nil {
 		panic(err)
 	}
 
 	cl := &configLog{}
 
-	serviceName := "ServiceName"
-	clientName := "ClientName"
+	serviceName := "ServiceName" // your server-side service name
+	clientName := "ClientName"   // your client-side service name
 	client, err := echo.NewClient(
 		serviceName,
 		client.WithHostPorts("0.0.0.0:8888"),

diff --git a/example/server/main.go b/example/server/main.go
@@ -39,7 +39,7 @@ func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Respon
 
 func main() {
 	klog.SetLevel(klog.LevelDebug)
-	serviceName := "ServiceName"
+	serviceName := "ServiceName" // your server-side service name
 	etcdClient, _ := etcd.NewClient(etcd.Options{})
 	svr := echo.NewServer(
 		new(EchoImpl),