Skip to content

Commit

Permalink
prepare version 3.0.0-RC1
Browse files Browse the repository at this point in the history
  • Loading branch information
vpriscan committed Feb 1, 2020
1 parent 79efc41 commit 98b4fa2
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 16 deletions.
52 changes: 37 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# RxKotlin

[![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)

## Kotlin Extensions for RxJava

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.


```kotlin
import io.reactivex.rxkotlin.subscribeBy
import io.reactivex.rxkotlin.toObservable
import io.reactivex.rxkotlin3.subscribeBy
import io.reactivex.rxkotlin3.toObservable

fun main(args: Array<String>) {

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


## Support for RxJava 1.x and RxJava 2.x
## Support for RxJava 1.x, RxJava 2.x and RxJava 3.x

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

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

Use RxKotlin 3.x versions to target RxJava 3.x.

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)`.

## Build

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

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

## Binaries

## Binaries

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).

### RxKotlin 3.x

Example for Maven:

```xml
<dependency>
<groupId>io.reactivex.rxjava3</groupId>
<artifactId>rxkotlin</artifactId>
<version>3.x.y</version>
</dependency>
```

Example for Gradle:

```kotlin
implementation("io.reactivex.rxjava3:rxkotlin:3.y.z")
```

### 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)
### RxKotlin 2.x

Example for Maven:

Expand All @@ -76,10 +98,10 @@ Example for Maven:
</dependency>
```

and for Gradle:
Example for Gradle:

```kotlin
implementation("io.reactivex.rxjava2:rxkotlin:x.y.z")
implementation("io.reactivex.rxjava2:rxkotlin:2.y.z")
```

### RxKotlin 1.x
Expand All @@ -94,25 +116,25 @@ Example for Maven:
</dependency>
```

and for Gradle:
Example for Gradle:

```kotlin
implementation("io.reactivex:rxkotlin:x.y.z")
implementation("io.reactivex:rxkotlin:1.y.z")
```

### Building with JitPack

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

For example, to build off the 2.x branch, use this setup for Gradle:
For example, to build off the 3.x branch, use this setup for Gradle:

```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.ReactiveX:RxKotlin:2.x-SNAPSHOT'
implementation 'com.github.ReactiveX:RxKotlin:3.x-SNAPSHOT'
}
```

Expand All @@ -126,10 +148,10 @@ Use this setup for Maven:
</repository>
</repositories>

<dependency>
<dependency>
<groupId>com.github.ReactiveX</groupId>
<artifactId>RxKotlin</artifactId>
<version>2.x-SNAPSHOT</version>
<version>3.x-SNAPSHOT</version>
</dependency>
```

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

## SAM Helpers

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.
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.

```
Observables.zip()
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
version=2.4.0
version=3.0.0-RC1
org.gradle.jvmargs=-Xms256m -Xmx1024m -XX:MaxPermSize=256m
kotlin.code.style=official

0 comments on commit 98b4fa2

Please sign in to comment.