From 690258e1c0853664dfebc4ffe8dd99e499eb41c6 Mon Sep 17 00:00:00 2001 From: Ashish Krishnan Date: Sun, 5 Aug 2018 13:31:52 +0530 Subject: [PATCH] 2.x: Update Getting started docs (#6136) * Remove troubleshooting guide. * Getting Started, all artifacts point to RxJava2. * Fix JFrog links to point to 2.x --- docs/Getting-Started.md | 63 ++++++++++++++++------------------------- 1 file changed, 24 insertions(+), 39 deletions(-) diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md index 1a95121c4e..fb9baa47dd 100644 --- a/docs/Getting-Started.md +++ b/docs/Getting-Started.md @@ -1,20 +1,20 @@ ## Getting Binaries -You can find binaries and dependency information for Maven, Ivy, Gradle, SBT, and others at [http://search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.reactivex%22%20AND%20a%3A%22rxjava%22). +You can find binaries and dependency information for Maven, Ivy, Gradle, SBT, and others at [http://search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Cg%3A"io.reactivex.rxjava2"%20AND%20"rxjava2"). Example for Maven: ```xml - io.reactivex + io.reactivex.rxjava2 rxjava - 1.3.4 + 2.2.0 ``` and for Ivy: ```xml - + ``` and for SBT: @@ -22,35 +22,35 @@ and for SBT: ```scala libraryDependencies += "io.reactivex" %% "rxscala" % "0.26.5" -libraryDependencies += "io.reactivex" % "rxjava" % "1.3.4" +libraryDependencies += "io.reactivex.rxjava2" % "rxjava" % "2.2.0" ``` and for Gradle: ```groovy -compile 'io.reactivex:rxjava:1.3.4' +compile 'io.reactivex.rxjava2:rxjava:2.2.0' ``` If you need to download the jars instead of using a build system, create a Maven `pom` file like this with the desired version: ```xml - - 4.0.0 - com.netflix.rxjava.download - rxjava-download - 1.0-SNAPSHOT - Simple POM to download rxjava and dependencies - http://github.com/ReactiveX/RxJava - - - io.reactivex - rxjava - 1.3.4 - - - + 4.0.0 + io.reactivex.rxjava2 + rxjava + 2.2.0 + RxJava + Reactive Extensions for Java + https://github.com/ReactiveX/RxJava + + + io.reactivex.rxjava2 + rxjava + 2.2.0 + + ``` @@ -66,7 +66,7 @@ You need Java 6 or later. ### Snapshots -Snapshots are available via [JFrog](https://oss.jfrog.org/webapp/search/artifact/?5&q=rxjava): +Snapshots are available via [JFrog](https://oss.jfrog.org/libs-snapshot/io/reactivex/rxjava2/rxjava/): ```groovy repositories { @@ -74,7 +74,7 @@ repositories { } dependencies { - compile 'io.reactivex:rxjava:1.3.y-SNAPSHOT' + compile 'io.reactivex.rxjava2:rxjava:2.2.0-SNAPSHOT' } ``` @@ -124,18 +124,3 @@ On a clean build you will see the unit tests run. They will look something like ``` > Building > :rxjava:test > 91 tests completed ``` - -#### Troubleshooting - -One developer reported getting the following error: - -> Could not resolve all dependencies for configuration ':language-adaptors:rxjava-scala:provided' - -He was able to resolve the problem by removing old versions of `scala-library` from `.gradle/caches` and `.m2/repository/org/scala-lang/` and then doing a clean build. (See this page for details.) - -You may get the following error during building RxJava: - -> Failed to apply plugin [id 'java'] -> Could not generate a proxy class for class nebula.core.NamedContainerProperOrder. - -It's a JVM issue, see [GROOVY-6951](https://jira.codehaus.org/browse/GROOVY-6951) for details. If so, you can run `export GRADLE_OPTS=-noverify` before building RxJava, or update your JDK.