Skip to content

Commit 690258e

Browse files
ashishkrishnanakarnokd
authored andcommitted
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
1 parent c146374 commit 690258e

File tree

1 file changed

+24
-39
lines changed

1 file changed

+24
-39
lines changed

docs/Getting-Started.md

Lines changed: 24 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
## Getting Binaries
22

3-
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).
3+
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").
44

55
Example for Maven:
66

77
```xml
88
<dependency>
9-
<groupId>io.reactivex</groupId>
9+
<groupId>io.reactivex.rxjava2</groupId>
1010
<artifactId>rxjava</artifactId>
11-
<version>1.3.4</version>
11+
<version>2.2.0</version>
1212
</dependency>
1313
```
1414
and for Ivy:
1515

1616
```xml
17-
<dependency org="io.reactivex" name="rxjava" rev="1.3.4" />
17+
<dependency org="io.reactivex.rxjava2" name="rxjava" rev="2.2.0" />
1818
```
1919

2020
and for SBT:
2121

2222
```scala
2323
libraryDependencies += "io.reactivex" %% "rxscala" % "0.26.5"
2424

25-
libraryDependencies += "io.reactivex" % "rxjava" % "1.3.4"
25+
libraryDependencies += "io.reactivex.rxjava2" % "rxjava" % "2.2.0"
2626
```
2727

2828
and for Gradle:
2929
```groovy
30-
compile 'io.reactivex:rxjava:1.3.4'
30+
compile 'io.reactivex.rxjava2:rxjava:2.2.0'
3131
```
3232

3333
If you need to download the jars instead of using a build system, create a Maven `pom` file like this with the desired version:
3434

3535
```xml
3636
<?xml version="1.0"?>
37-
<project xmlns="http://maven.apache.org/POM/4.0.0"
38-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
37+
<project xmlns="http://maven.apache.org/POM/4.0.0"
38+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3939
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
40-
<modelVersion>4.0.0</modelVersion>
41-
<groupId>com.netflix.rxjava.download</groupId>
42-
<artifactId>rxjava-download</artifactId>
43-
<version>1.0-SNAPSHOT</version>
44-
<name>Simple POM to download rxjava and dependencies</name>
45-
<url>http://github.com/ReactiveX/RxJava</url>
46-
<dependencies>
47-
<dependency>
48-
<groupId>io.reactivex</groupId>
49-
<artifactId>rxjava</artifactId>
50-
<version>1.3.4</version>
51-
<scope/>
52-
</dependency>
53-
</dependencies>
40+
<modelVersion>4.0.0</modelVersion>
41+
<groupId>io.reactivex.rxjava2</groupId>
42+
<artifactId>rxjava</artifactId>
43+
<version>2.2.0</version>
44+
<name>RxJava</name>
45+
<description>Reactive Extensions for Java</description>
46+
<url>https://github.com/ReactiveX/RxJava</url>
47+
<dependencies>
48+
<dependency>
49+
<groupId>io.reactivex.rxjava2</groupId>
50+
<artifactId>rxjava</artifactId>
51+
<version>2.2.0</version>
52+
</dependency>
53+
</dependencies>
5454
</project>
5555
```
5656

@@ -66,15 +66,15 @@ You need Java 6 or later.
6666

6767
### Snapshots
6868

69-
Snapshots are available via [JFrog](https://oss.jfrog.org/webapp/search/artifact/?5&q=rxjava):
69+
Snapshots are available via [JFrog](https://oss.jfrog.org/libs-snapshot/io/reactivex/rxjava2/rxjava/):
7070

7171
```groovy
7272
repositories {
7373
maven { url 'https://oss.jfrog.org/libs-snapshot' }
7474
}
7575
7676
dependencies {
77-
compile 'io.reactivex:rxjava:1.3.y-SNAPSHOT'
77+
compile 'io.reactivex.rxjava2:rxjava:2.2.0-SNAPSHOT'
7878
}
7979
```
8080

@@ -124,18 +124,3 @@ On a clean build you will see the unit tests run. They will look something like
124124
```
125125
> Building > :rxjava:test > 91 tests completed
126126
```
127-
128-
#### Troubleshooting
129-
130-
One developer reported getting the following error:
131-
132-
> Could not resolve all dependencies for configuration ':language-adaptors:rxjava-scala:provided'
133-
134-
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. <a href="https://gist.github.com/jaceklaskowski/9496058">(See this page for details.)</a>
135-
136-
You may get the following error during building RxJava:
137-
138-
> Failed to apply plugin [id 'java']
139-
> Could not generate a proxy class for class nebula.core.NamedContainerProperOrder.
140-
141-
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.

0 commit comments

Comments
 (0)