documentation

Alexander Furer · Alexander Furer · commit 596087e5ca48 · 2017-09-05T17:48:32.000+03:00
diff --git a/README.adoc b/README.adoc
@@ -1,5 +1,8 @@
 = Spring boot starter for http://www.grpc.io/[gRPC framework.] https://bintray.com/lognet/maven/grpc-spring-boot-starter/_latestVersion[ image:https://api.bintray.com/packages/lognet/maven/grpc-spring-boot-starter/images/download.svg[Download]] image:https://travis-ci.org/LogNet/grpc-spring-boot-starter.svg?branch=master[Build Status,link=https://travis-ci.org/LogNet/grpc-spring-boot-starter] image:https://codecov.io/gh/LogNet/grpc-spring-boot-starter/branch/master/graph/badge.svg["Codecov", link="https://codecov.io/gh/LogNet/grpc-spring-boot-starter/branch/master"] https://bintray.com/lognet/maven/grpc-spring-boot-starter?source=watch[ image:https://www.bintray.com/docs/images/bintray_badge_color.png[]]
 :toc:
+:source-highlighter: prettify
+:numbered:
+:icons: font
 
 
 == Features
@@ -25,12 +28,29 @@ dependencies {
 * Start by https://github.com/google/protobuf-gradle-plugin[generating] stub and server interface(s) from your `.proto` file(s).
 * Annotate your server interface implementation(s) with `@org.lognet.springboot.grpc.GRpcService`
 * Optionally configure the server port in your `application.yml/properties`. Default port is `6565`
+
 [source,yaml]
 ----
  grpc:
-    port : 6565
+    port: 6565
 ----
 
+The starter supports also the  `in-process server`, which should be used for testing purposes :
+
+[source,yaml]
+----
+ grpc:
+    enabled: false <1>
+    inProcessServerName: myTestServer <2>
+----
+<1> Disables the default server (`NettyServer`).
+<2> Enables the in-process server.
+
+[NOTE]
+If you enable both the `NettyServer` and `in-process` server, they will both share the same instance of `HealthStatusManager` and `GRpcServerBuilderConfigurer` (see <<Custom gRPC Server Configuration>>).
+
+
+
 == Show case
 
 In the 'grpc-spring-boot-starter-demo' project you can find fully functional example with integration test.
@@ -159,6 +179,10 @@ public class MyGRpcServerBuilderConfigurer extends GRpcServerBuilderConfigurer()
 }
 ----
 
+[NOTE]
+If you enable both `NettyServer` and `in-process` servers, the `configure` method will be invoked on the same instance og configurer.
+If you need to differentiate between the passed `serverBuilder`s, you can check the type. This is the current limitation.
+
 == Eureka Integration
 
 When building production-ready services, the advise is to have separate project for your service(s) gRPC API that holds only proto-generated classes both for server and client side usage. +
