Skip to content

Commit 736b355

Browse files
authored
Update README.md
1 parent c0cf836 commit 736b355

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### RSOCKET-ANDROID
1+
# RSOCKET-ANDROID
22

33
This is an implementation of [RSocket](http://rsocket.io/) - binary application protocol bringing [Reactive-Streams](http://www.reactive-streams.org/) semantics
44
for network communications.
@@ -7,10 +7,25 @@ Relies on `OkHttp` as WebSockets transport. Target platform is Android (tested o
77

88
Supports 4 interaction models: fire-and-forget, request-response, request-stream, request-channel.
99

10-
##### USAGE
10+
## Build and Binaries
11+
12+
<a href='https://travis-ci.org/rsocket/rsocket-java/builds'><img src='https://travis-ci.org/rsocket/rsocket-java.svg?branch=1.0.x'></a>
13+
14+
15+
The project is not released yet, so snapshots have to be installed locally with `./gradlew install`
16+
This will produce 2 artifacts:
17+
18+
```groovy
19+
dependencies {
20+
compile 'io.rsocket:rsocket-android-core:0.9-SNAPSHOT'
21+
compile 'io.rsocket:rsocket-transport-okhttp:0.9-SNAPSHOT'
22+
}
23+
```
24+
25+
## USAGE
1126
Sample mobile application for verifying interactions is available [here](https://github.com/mostroverkhov/rsocket-backport-demo)
1227

13-
######Client
28+
### Client
1429
Client initiates new `Connections`. Because protocol is duplex, each side of connection has
1530
`Requester` RSocket for making requests to peer, and `Responder` RSocket to handle
1631
requests from peer. `Responder` RSocket is optional for Client.
@@ -49,19 +64,8 @@ Supports 4 interaction models: fire-and-forget, request-response, request-stream
4964
PayloadImpl("req-channel2")))
5065
}.subscribe { responsePayload -> Log.d("request-stream", responsePayload.getDataUtf8)}
5166
```
52-
######Server
67+
### Server
5368
Server accepts new `Connections` from peers. Same as `Client` it has `Requester` and `Responder` RSockets.
5469
As this project does not provide server implementation, use [RSocket-java](https://github.com/rsocket/rsocket-java) with `Netty` based `WebSockets`
5570
transport. Check its [examples](https://github.com/rsocket/rsocket-java/tree/1.0.x/rsocket-examples) folder or sample [app](https://github.com/mostroverkhov/rsocket-backport-demo/tree/master/rsocket-server-netty) minimalistic server
5671

57-
##### Build and binaries
58-
59-
The project is not released yet, so snapshots have to be installed locally with `./gradlew install`
60-
This will produce 2 artifacts:
61-
62-
```groovy
63-
dependencies {
64-
compile 'io.rsocket:rsocket-android-core:0.9-SNAPSHOT'
65-
compile 'io.rsocket:rsocket-transport-okhttp:0.9-SNAPSHOT'
66-
}
67-
```

0 commit comments

Comments
 (0)