From 98b4fa2e6adec5eaabf73a661d20715636bbce12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Pri=C5=A1=C4=87an?= Date: Sat, 1 Feb 2020 16:39:25 +0100 Subject: [PATCH] prepare version 3.0.0-RC1 --- README.md | 52 +++++++++++++++++++++++++++++++++-------------- gradle.properties | 2 +- 2 files changed, 38 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 7dd2e7a..1b9f1c3 100755 --- a/README.md +++ b/README.md @@ -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) { @@ -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 + + io.reactivex.rxjava3 + rxkotlin + 3.x.y + +``` + +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: @@ -76,10 +98,10 @@ Example for Maven: ``` -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 @@ -94,17 +116,17 @@ Example for Maven: ``` -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 { @@ -112,7 +134,7 @@ repositories { } dependencies { - implementation 'com.github.ReactiveX:RxKotlin:2.x-SNAPSHOT' + implementation 'com.github.ReactiveX:RxKotlin:3.x-SNAPSHOT' } ``` @@ -126,10 +148,10 @@ Use this setup for Maven: - + com.github.ReactiveX RxKotlin - 2.x-SNAPSHOT + 3.x-SNAPSHOT ``` @@ -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() diff --git a/gradle.properties b/gradle.properties index 29d2773..cc47c0b 100644 --- a/gradle.properties +++ b/gradle.properties @@ -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 \ No newline at end of file