Skip to content

Commit 3621595

Browse files
author
jvmlet
committed
convert readme to ASCIIDOC
1 parent 259e995 commit 3621595

File tree

1 file changed

+33
-23
lines changed

1 file changed

+33
-23
lines changed
Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,56 @@
1-
#Spring boot starter for [gRPC framework.](http://www.grpc.io/)
2-
[![Build Status](https://travis-ci.org/LogNet/grpc-spring-boot-starter.svg?branch=master)](https://travis-ci.org/LogNet/grpc-spring-boot-starter)
3-
[ ![Download](https://api.bintray.com/packages/lognet/maven/grpc-spring-boot-starter/images/download.svg) ](https://bintray.com/lognet/maven/grpc-spring-boot-starter/_latestVersion)
4-
## Features
1+
= Spring boot starter for http://www.grpc.io/[gRPC framework.]
2+
3+
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]
4+
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] ]
5+
6+
== Features
57
68
Auto-configures and run the embedded gRPC server with @GRpcService-enabled beans as part of spring-boot application.
79
8-
## Setup
10+
== Setup
911
10-
```gradle
12+
[source,gradle]
13+
----
1114
repositories {
1215
jcenter()
1316
// maven { url "http://oss.jfrog.org/oss-snapshot-local" } //for snashot builds
1417
1518
}
1619
dependencies {
17-
compile('org.lognet:grpc-spring-boot-starter:0.0.4')
20+
compile('org.lognet:grpc-spring-boot-starter:0.0.5')
1821
}
19-
```
22+
----
23+
2024
If you are using protobuf version lower than `3.0.0`, please use `org.lognet:grpc-spring-boot-starter:0.0.3`
2125
26+
== Usage
2227
23-
## Usage
24-
* Start by [generating](https://github.com/google/protobuf-gradle-plugin) stub and server interface(s) from your `.proto` file(s).
28+
* Start by https://github.com/google/protobuf-gradle-plugin[generating] stub and server interface(s) from your `.proto` file(s).
2529
* Annotate your server interface implementation(s) with `@org.lognet.springboot.grpc.GRpcService`
2630
* Optionally configure the server port in your `application.yml/properties`. Default port is `6565`
27-
28-
```yaml
31+
[source,yaml]
32+
----
2933
grpc:
3034
port : 6565
31-
```
32-
## Show case
35+
----
36+
37+
== Show case
38+
3339
In the 'grpc-spring-boot-starter-demo' project you can find fully functional example with integration test.
3440
The service definition from `.proto` file looks like this :
35-
```proto
41+
[source,proto]
42+
----
3643
service Greeter {
3744
rpc SayHello ( HelloRequest) returns ( HelloReply) {}
3845
}
39-
```
40-
Note the generated `io.grpc.examples.GreeterGrpc.GreeterImplBase` class that extends `io.grpc.BindableService`.(The generated classes were intentionally committed for demo purposes).
46+
----
47+
48+
Note the generated `io.grpc.examples.GreeterGrpc.GreeterImplBase` class that extends `io.grpc.BindableService`.(The generated classes were intentionally committed for demo purposes).
4149
4250
All you need to do is to annotate your service implementation with `@org.lognet.springboot.grpc.GRpcService`
4351
44-
```java
52+
[source,java]
53+
----
4554
@GRpcService
4655
public static class GreeterService extends GreeterGrpc.GreeterImplBase{
4756
@Override
@@ -51,12 +60,13 @@ All you need to do is to annotate your service implementation with `@org.lognet.
5160
responseObserver.onCompleted();
5261
}
5362
}
54-
```
63+
----
64+
65+
== On the roadmap
5566
56-
## On the roadmap
57-
* Customized gRPC server builder with compression/decompression registry, custom `Executor` service and transport security.
67+
* Customized gRPC server builder with compression/decompression registry, custom `Executor` service and transport security.
5868
* `ServerInterceptor` support.
5969
70+
== License
6071
61-
## License
62-
Apache 2.0
72+
Apache 2.0

0 commit comments

Comments
 (0)