Skip to content

Commit 13bbfbc

Browse files
committed
docs [skip ci]
1 parent 430329a commit 13bbfbc

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.adoc

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,20 @@ Autoconfigures and runs the embedded gRPC server with @GRpcService-enabled beans
2727
== Setup
2828

2929

30-
[IMPORTANT]
31-
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.
30+
=== Long story shot
31+
32+
`Gradle` users are advised to apply the plugin :
33+
34+
[source,groovy]
35+
----
36+
plugins {
37+
id "io.github.lognet.grpc-spring-boot" version '5.1.4'
38+
}
39+
----
40+
41+
link:./grpc-spring-boot-starter-gradle-plugin/README.adoc[io.github.lognet.grpc-spring-boot^] gradle plugin dramatically simplifies the project setup.
42+
43+
=== Short story long
3244

3345
[source,groovy]
3446
----
@@ -71,9 +83,13 @@ configurations.all {
7183
[NOTE]
7284
The release notes with compatibility matrix can be found link:ReleaseNotes.md[here^]
7385

86+
Follow this https://github.com/google/protobuf-gradle-plugin[guide^] to generate stub and server interface(s) from your `.proto` file(s). +
87+
88+
If you are stack with maven - use this https://www.google.com/search?q=protobuf+maven+plugin[link^].
89+
7490
== Usage
7591

76-
* Start by https://github.com/google/protobuf-gradle-plugin[generating] stub and server interface(s) from your `.proto` file(s).
92+
7793
* Annotate your server interface implementation(s) with `@org.lognet.springboot.grpc.GRpcService`
7894
* Optionally configure the server port in your `application.yml/properties`.
7995
Default port is `6565`.

0 commit comments

Comments
 (0)