update README

DanielLiu1123 · Dec 22, 2024 · cf210a0 · cf210a0
1 parent 2c9dfb1
commit cf210a0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -14,12 +14,12 @@ implementation("io.grpc:grpc-testing-proto")
 
 ```java
 @SpringBootApplication
-public class SimpleApp extends SimpleServiceGrpc.SimpleServiceImplBase {
+public class QuickStartApp extends SimpleServiceGrpc.SimpleServiceImplBase {
 
     public static void main(String[] args) {
-        new SpringApplicationBuilder(SimpleApp.class)
-                .properties("grpc.client.base-packages=io.grpc")
-                .properties("grpc.client.authority=127.0.0.1:9090")
+        new SpringApplicationBuilder(QuickStartApp.class)
+                .properties("grpc.client.base-packages=io.grpc") // scan packages for gRPC clients
+                .properties("grpc.client.authority=127.0.0.1:9090") // default authority for gRPC clients
                 .run(args);
     }
 
@@ -33,13 +33,12 @@ public class SimpleApp extends SimpleServiceGrpc.SimpleServiceImplBase {
     }
 
     @Bean
-    ApplicationRunner runner(SimpleServiceGrpc.SimpleServiceBlockingStub stub) {
+    ApplicationRunner runner(SimpleServiceGrpc.SimpleServiceBlockingStub stub) { // inject gRPC client
         return args -> {
             var response = stub.unaryRpc(SimpleRequest.newBuilder().setRequestMessage("World!").build());
             System.out.println(response.getResponseMessage());
         };
     }
-
 }
 ```
 

diff --git a/website/docs/05-quickstart.mdx b/website/docs/05-quickstart.mdx
@@ -59,8 +59,8 @@ public class QuickStartApp extends SimpleServiceGrpc.SimpleServiceImplBase {
 
     public static void main(String[] args) {
         new SpringApplicationBuilder(QuickStartApp.class)
-                .properties("grpc.client.base-packages=io.grpc")
-                .properties("grpc.client.authority=127.0.0.1:9090")
+                .properties("grpc.client.base-packages=io.grpc") // scan packages for gRPC clients
+                .properties("grpc.client.authority=127.0.0.1:9090") // default authority for gRPC clients
                 .run(args);
     }
 
@@ -74,13 +74,12 @@ public class QuickStartApp extends SimpleServiceGrpc.SimpleServiceImplBase {
     }
 
     @Bean
-    ApplicationRunner runner(SimpleServiceGrpc.SimpleServiceBlockingStub stub) { // Inject gRPC stub
+    ApplicationRunner runner(SimpleServiceGrpc.SimpleServiceBlockingStub stub) { // inject gRPC client
         return args -> {
             var response = stub.unaryRpc(SimpleRequest.newBuilder().setRequestMessage("World!").build());
             System.out.println(response.getResponseMessage());
         };
     }
-
 }
 ```