From 13bbfbcbe55a6e1b5beac9f949e5865e1e9ff863 Mon Sep 17 00:00:00 2001 From: Alexander Furer Date: Mon, 4 Sep 2023 09:02:29 +0300 Subject: [PATCH] docs [skip ci] --- README.adoc | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 9a12611..06b0105 100644 --- a/README.adoc +++ b/README.adoc @@ -27,8 +27,20 @@ Autoconfigures and runs the embedded gRPC server with @GRpcService-enabled beans == Setup -[IMPORTANT] -Make sure to check out the link:./grpc-spring-boot-starter-gradle-plugin/README.adoc[io.github.lognet.grpc-spring-boot^] gradle plugin that dramatically simplifies the project setup. +=== Long story shot + +`Gradle` users are advised to apply the plugin : + +[source,groovy] +---- +plugins { +id "io.github.lognet.grpc-spring-boot" version '5.1.4' +} +---- + +link:./grpc-spring-boot-starter-gradle-plugin/README.adoc[io.github.lognet.grpc-spring-boot^] gradle plugin dramatically simplifies the project setup. + +=== Short story long [source,groovy] ---- @@ -71,9 +83,13 @@ configurations.all { [NOTE] The release notes with compatibility matrix can be found link:ReleaseNotes.md[here^] +Follow this https://github.com/google/protobuf-gradle-plugin[guide^] to generate stub and server interface(s) from your `.proto` file(s). + + +If you are stack with maven - use this https://www.google.com/search?q=protobuf+maven+plugin[link^]. + == Usage -* 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`.