Skip to content

Commit 98b4fa2

Browse files
committed
prepare version 3.0.0-RC1
1 parent 79efc41 commit 98b4fa2

File tree

2 files changed

+38
-16
lines changed

2 files changed

+38
-16
lines changed

README.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# RxKotlin
22

3+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.reactivex.rxjava2/rxkotlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.reactivex.rxjava2/rxkotlin)
4+
35
## Kotlin Extensions for RxJava
46

57
RxKotlin is a lightweight library that adds convenient extension functions to [RxJava](https://github.com/ReactiveX/RxJava). You can use RxJava with Kotlin out-of-the-box, but Kotlin has language features (such as [extension functions](https://kotlinlang.org/docs/reference/extensions.html)) that can streamline usage of RxJava even more. RxKotlin aims to conservatively collect these conveniences in one centralized library, and standardize conventions for using RxJava with Kotlin.
68

79

810
```kotlin
9-
import io.reactivex.rxkotlin.subscribeBy
10-
import io.reactivex.rxkotlin.toObservable
11+
import io.reactivex.rxkotlin3.subscribeBy
12+
import io.reactivex.rxkotlin3.toObservable
1113

1214
fun main(args: Array<String>) {
1315

@@ -45,26 +47,46 @@ Join us on the #rx channel in Kotlin Slack!
4547
https://kotlinlang.slack.com/messages/rx
4648

4749

48-
## Support for RxJava 1.x and RxJava 2.x
50+
## Support for RxJava 1.x, RxJava 2.x and RxJava 3.x
4951

5052
Use RxKotlin 1.x versions to target RxJava 1.x.
5153

5254
Use RxKotlin 2.x versions to target RxJava 2.x.
5355

56+
Use RxKotlin 3.x versions to target RxJava 3.x.
57+
5458
The maintainers do not update the RxJava dependency version for every RxJava release, so you should explicitly add the desired RxJava dependency version to your `pom.xml` or `build.gradle(.kts)`.
5559

5660
## Build
5761

58-
[![Build Status](https://travis-ci.org/ReactiveX/RxKotlin.svg?branch=2.x)](https://travis-ci.org/ReactiveX/RxKotlin)
62+
RxKotlin 3.x [![Build Status](https://travis-ci.org/ReactiveX/RxKotlin.svg?branch=3.x)](https://travis-ci.org/ReactiveX/RxKotlin)
5963

64+
RxKotlin 2.x [![Build Status](https://travis-ci.org/ReactiveX/RxKotlin.svg?branch=2.x)](https://travis-ci.org/ReactiveX/RxKotlin)
6065

61-
## Binaries
6266

67+
## Binaries
6368

6469
Binaries and dependency information for Maven, Ivy, Gradle and others can be found at [http://search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Crxkotlin).
6570

71+
### RxKotlin 3.x
72+
73+
Example for Maven:
74+
75+
```xml
76+
<dependency>
77+
<groupId>io.reactivex.rxjava3</groupId>
78+
<artifactId>rxkotlin</artifactId>
79+
<version>3.x.y</version>
80+
</dependency>
81+
```
82+
83+
Example for Gradle:
84+
85+
```kotlin
86+
implementation("io.reactivex.rxjava3:rxkotlin:3.y.z")
87+
```
6688

67-
### RxKotlin 2.x [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.reactivex.rxjava2/rxkotlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.reactivex.rxjava2/rxkotlin)
89+
### RxKotlin 2.x
6890

6991
Example for Maven:
7092

@@ -76,10 +98,10 @@ Example for Maven:
7698
</dependency>
7799
```
78100

79-
and for Gradle:
101+
Example for Gradle:
80102

81103
```kotlin
82-
implementation("io.reactivex.rxjava2:rxkotlin:x.y.z")
104+
implementation("io.reactivex.rxjava2:rxkotlin:2.y.z")
83105
```
84106

85107
### RxKotlin 1.x
@@ -94,25 +116,25 @@ Example for Maven:
94116
</dependency>
95117
```
96118

97-
and for Gradle:
119+
Example for Gradle:
98120

99121
```kotlin
100-
implementation("io.reactivex:rxkotlin:x.y.z")
122+
implementation("io.reactivex:rxkotlin:1.y.z")
101123
```
102124

103125
### Building with JitPack
104126

105127
You can also use Gradle or Maven with [JitPack](https://jitpack.io/) to build directly off a snapshot, branch, or commit of this repository.
106128

107-
For example, to build off the 2.x branch, use this setup for Gradle:
129+
For example, to build off the 3.x branch, use this setup for Gradle:
108130

109131
```groovy
110132
repositories {
111133
maven { url 'https://jitpack.io' }
112134
}
113135
114136
dependencies {
115-
implementation 'com.github.ReactiveX:RxKotlin:2.x-SNAPSHOT'
137+
implementation 'com.github.ReactiveX:RxKotlin:3.x-SNAPSHOT'
116138
}
117139
```
118140

@@ -126,10 +148,10 @@ Use this setup for Maven:
126148
</repository>
127149
</repositories>
128150

129-
<dependency>
151+
<dependency>
130152
<groupId>com.github.ReactiveX</groupId>
131153
<artifactId>RxKotlin</artifactId>
132-
<version>2.x-SNAPSHOT</version>
154+
<version>3.x-SNAPSHOT</version>
133155
</dependency>
134156
```
135157

@@ -210,7 +232,7 @@ Learn more about building this project with JitPack [here](https://jitpack.io/#R
210232

211233
## SAM Helpers
212234

213-
To help cope with the [SAM ambiguity issue](https://youtrack.jetbrains.com/issue/KT-14984) when using RxJava 2.x with Kotlin, there are a number of helper factories and extension functions to workaround the affected operators.
235+
To help cope with the [SAM ambiguity issue](https://youtrack.jetbrains.com/issue/KT-14984) when using RxJava with Kotlin, there are a number of helper factories and extension functions to workaround the affected operators.
214236

215237
```
216238
Observables.zip()

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
version=2.4.0
1+
version=3.0.0-RC1
22
org.gradle.jvmargs=-Xms256m -Xmx1024m -XX:MaxPermSize=256m
33
kotlin.code.style=official

0 commit comments

Comments
 (0)