Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 2.85 KB

README.md

File metadata and controls

70 lines (54 loc) · 2.85 KB
Raw

RxReactor

Maven Central Master Build Coverage RxJava 1 javadocs RxJava 2 javadocs RxJava 3 javadocs

RxReactor is a Kotlin framework for a reactive and unidirectional RxJava-based application architecture. This repository introduces the basic concept of RxReactor and describes how to build an application using it. It is available to using with Kotlin on any JVM as well as Android.

Usage

TODO: Usage stuff

Download

Releases are published to Maven Central, and individual archives are also available in the Releases for the project.

subprojects {
    repositiories {
        mavenCentral()
    }
}

Add this repository to have access to Maven Central snapshots:

subprojects {
    repositiories {
        maven {
            url 'https://oss.sonatype.org/content/repositories/snapshots/'
            mavenContent { snapshotsOnly() }
        }
    }
}

For RxJava 1:

compile 'com.gyurigrell.rxreactor:rxreactor1:1.0.0' // Add -SNAPSHOT for snapshot versions
compile 'com.gyurigrell.rxreactor:rxreactor1-android:1.0.0' // Optional, add -SNAPSHOT for snapshot versions

or for RxJava 2:

compile 'com.gyurigrell.rxreactor:rxreactor2:1.0.0' // Add -SNAPSHOT for snapshot versions
compile 'com.gyurigrell.rxreactor:rxreactor2-android:1.0.0' // Optional, add -SNAPSHOT for snapshot versions

or for RxJava 3:

compile 'com.gyurigrell.rxreactor:rxreactor3:1.0.0' // Add -SNAPSHOT for snapshot versions
compile 'com.gyurigrell.rxreactor:rxreactor3-android:1.0.0' // Optional, add -SNAPSHOT for snapshot versions

Demo Projects

The repo currently contains a simple login test app with lookup of existing emails on the device. The LoginViewModel handles loading on-device email addresses for lookup as the user is typing.

Contributing

TBD

License

BSD 3-Clause License

Credits

Port of https://github.com/ReactorKit/ReactorKit to Kotlin