Skip to content

Commit fa565cb

Browse files
committed
Update changes.md and readme.md
1 parent 7e0f6d8 commit fa565cb

File tree

2 files changed

+41
-45
lines changed

2 files changed

+41
-45
lines changed

CHANGES.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# RxJava Releases #
22

33
Version 1.x can be found at https://github.com/ReactiveX/RxJava/blob/1.x/CHANGES.md
4+
5+
### Version 2.0.0-RC1 - August 25, 2016 ([Maven](http://search.maven.org/#artifactdetails%7Cio.reactivex.rxjava2%7Crxjava%7C2.0.0-RC1%7C))
6+
7+
RxJava 2.0 has been rewritten from scratch to be more performant, lower overhead (memory and cpu) and to natively implement the Reactive-Streams specification in its new `Flowable` type. The library still supports Java 6+ and is considered a **4th generation reactive library**.
8+
9+
There have been hundreds of PRs and large amounts of changes compared to the 1.x version. The two are binary-incompatible but their distinct maven coordinates (`io.reactivex.rxjava2:rxjava:2.0.0-RC1`) allow them to co-exist. You can use the [rxjava2-interop](https://github.com/akarnokd/RxJava2Interop) library to convert between 1.x and 2.x types.
10+
11+
Please refer to the [wiki page about the differences between the two major versions](https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0).
12+
13+
Converting the companion libraries is an ongoing effort. For now, see the [rxjava2-extensions](https://github.com/akarnokd/RxJava2Extensions) project that contains the port of the [RxJavaMath](https://github.com/ReactiveX/RxJavaMath) features. Note that most companion libraries of RxJava are currently not set up properly for release (the signing keys are missing from the CI release process) and is unknown if and when they will have their own 2.x release branch.
14+
15+
I'd like to thank for the contributions of the following community members (in LIFO commit-merge order):
16+
17+
@davidmoten, @JakeWharton, @vanniktech, @dimitar-asenov, @artem-zinnatullin, @bobvanderlinden, @DmitriyZaitsev, @zsxwing, @bcorne, @stevegury, @benjchristensen, @stealthcode, @adam-arold and @abersnaze.
18+
19+
A special thanks goes out to @smaldini, [Project-Reactor](https://github.com/reactor/reactor-core) lead at Pivotal. Our ongoing cooperation lead to the massive improvement of the RxJava 2.x architecture (originally designed in August 2015) by learning from and building upon the results of the [Reactive-Streams-Commons](https://github.com/reactor/reactive-streams-commons) research project.

README.md

Lines changed: 25 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,36 @@
11
# RxJava: Reactive Extensions for the JVM
22

3+
<a href='https://travis-ci.org/ReactiveX/RxJava/builds'><img src='https://travis-ci.org/ReactiveX/RxJava.svg?branch=2.x'></a>
4+
[![codecov.io](http://codecov.io/github/ReactiveX/RxJava/coverage.svg?branch=2.x)](http://codecov.io/github/ReactiveX/RxJava?branch=2.x)
5+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.reactivex.rxjava2/rxjava/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.reactivex.rxjava2/rxjava)
6+
37
RxJava is a Java VM implementation of [Reactive Extensions](http://reactivex.io): a library for composing asynchronous and event-based programs by using observable sequences.
48

59
It extends the [observer pattern](http://en.wikipedia.org/wiki/Observer_pattern) to support sequences of data/events and adds operators that allow you to compose sequences together declaratively while abstracting away concerns about things like low-level threading, synchronization, thread-safety and concurrent data structures.
610

711
#### Version 2.x
812

9-
Version 2.x and 1.x will live side-by-side for several years. They will have different group ids (`io.reactivex.rxjava2` vs `io.reactivex`) and namespaces (`io.reactivex` vs `rx`).
13+
- single dependency: [Reactive-Streams](https://github.com/reactive-streams/reactive-streams-jvm)
14+
- continued support for Java 6+ & [Android](https://github.com/ReactiveX/RxAndroid) 2.3+
15+
- performance gains through design changes learned through the 1.x cycle and through [Reactive-Streams-Commons](https://github.com/reactor/reactive-streams-commons) research project.
16+
- Java 8 lambda-friendly API
17+
- non-opinionated about source of concurrency (threads, pools, event loops, fibers, actors, etc)
18+
- async or synchronous execution
19+
- virtual time and schedulers for parameterized concurrency
1020

11-
The purpose for 2.x is:
1221

13-
- continued support for Java 6+ & [Android](https://github.com/ReactiveX/RxAndroid) 2.3+
14-
- [Reactive Streams](http://www.reactive-streams.org) compatibility
15-
- performance gains through design changes learned through the 1.x cycle
22+
Version 2.x and 1.x will live side-by-side for several years. They will have different group ids (`io.reactivex.rxjava2` vs `io.reactivex`) and namespaces (`io.reactivex` vs `rx`).
23+
24+
See the differences between version 1.x and 2.x in the wiki article [What's different in 2.0](https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0). Learn more about RxJava in general on the <a href="https://github.com/ReactiveX/RxJava/wiki">Wiki Home</a>.
1625

1726
##### Releases
1827

1928
The release plan for 2.x is as [follows](https://github.com/ReactiveX/RxJava/issues/4016):
2029

21-
- 26/08/2016: Release Candidate 1: stabilized API and feature set
30+
- **25/08/2016: Release Candidate 1: stabilized API and feature set**
2231
- 23/09/2016: Release Candidate 2: addressing feedback from RC 1
2332
- 21/10/2016: Release Candidate 3: addressing feedback from RC 2
2433
- 29/10/2016: Stable Release: General availability
25-
26-
The snapshots of merges into the 2.x branch (developer preview) are available as follows:
27-
28-
```
29-
repositories {
30-
maven { url 'https://oss.jfrog.org/libs-snapshot' }
31-
}
32-
33-
dependencies {
34-
compile 'io.reactivex.rxjava2:rxjava:2.0.0-DP0-SNAPSHOT'
35-
}
36-
```
37-
38-
#### Version 1.x
39-
40-
- Zero Dependencies
41-
- < 800KB Jar
42-
- Java 6+ & [Android](https://github.com/ReactiveX/RxAndroid) 2.3+
43-
- Java 8 lambda support
44-
- Polyglot ([Scala](https://github.com/ReactiveX/RxScala), [Groovy](https://github.com/ReactiveX/RxGroovy), [Clojure](https://github.com/ReactiveX/RxClojure) and [Kotlin](https://github.com/ReactiveX/RxKotlin))
45-
- Non-opinionated about source of concurrency (threads, pools, event loops, fibers, actors, etc)
46-
- Async or synchronous execution
47-
- Virtual time and schedulers for parameterized concurrency
48-
49-
Learn more about RxJava on the <a href="https://github.com/ReactiveX/RxJava/wiki">Wiki Home</a>.
50-
51-
## Master Build Status
52-
53-
<a href='https://travis-ci.org/ReactiveX/RxJava/builds'><img src='https://travis-ci.org/ReactiveX/RxJava.svg?branch=2.x'></a>
54-
[![codecov.io](http://codecov.io/github/ReactiveX/RxJava/coverage.svg?branch=2.x)](http://codecov.io/github/ReactiveX/RxJava?branch=2.x)
5534

5635
## Communication
5736

@@ -61,7 +40,7 @@ Learn more about RxJava on the <a href="https://github.com/ReactiveX/RxJava/wiki
6140

6241
## Versioning
6342

64-
Version 2.x has started development.
43+
Version 2.x has reached Release Candidate 1.
6544

6645
Version 1.x is now a stable API and will be supported for several years.
6746

@@ -81,38 +60,38 @@ APIs marked with the [`@Experimental`][experimental source link] annotation at t
8160

8261
APIs marked with the `@Deprecated` annotation at the class or method level will remain supported until the next major release but it is recommended to stop using them.
8362

84-
#### rx.internal.*
63+
#### io.reactivex.internal.*
8564

86-
All code inside the `rx.internal.*` packages is considered private API and should not be relied upon at all. It can change at any time.
65+
All code inside the `io.reactivex.internal.*` packages is considered private API and should not be relied upon at all. It can change at any time.
8766

8867
## Full Documentation
8968

9069
- [Wiki](https://github.com/ReactiveX/RxJava/wiki)
91-
- [Javadoc](http://reactivex.io/RxJava/javadoc/)
70+
- [Javadoc](http://reactivex.io/RxJava/javadoc/2.x/)
9271

9372
## Binaries
9473

95-
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%7Cio.reactivex.rxjava).
74+
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%7Cio.reactivex.rxjava2).
9675

9776
Example for Gradle:
9877

9978
```groovy
100-
compile 'io.reactivex:rxjava:x.y.z'
79+
compile 'io.reactivex.rxjava2:rxjava:x.y.z'
10180
```
10281

10382
and for Maven:
10483

10584
```xml
10685
<dependency>
107-
<groupId>io.reactivex</groupId>
86+
<groupId>io.reactivex.rxjava2</groupId>
10887
<artifactId>rxjava</artifactId>
10988
<version>x.y.z</version>
11089
</dependency>
11190
```
11291
and for Ivy:
11392

11493
```xml
115-
<dependency org="io.reactivex" name="rxjava" rev="x.y.z" />
94+
<dependency org="io.reactivex.rxjava2" name="rxjava" rev="x.y.z" />
11695
```
11796

11897
Snapshots are available via [JFrog](https://oss.jfrog.org/webapp/search/artifact/?5&q=rxjava):
@@ -123,7 +102,7 @@ repositories {
123102
}
124103
125104
dependencies {
126-
compile 'io.reactivex:rxjava:1.0.y-SNAPSHOT'
105+
compile 'io.reactivex.rxjava2:rxjava:2.0.0-DP0-SNAPSHOT'
127106
}
128107
```
129108

@@ -133,6 +112,7 @@ To build:
133112

134113
```
135114
$ git clone [email protected]:ReactiveX/RxJava.git
115+
$ git checkout -b 2.x
136116
$ cd RxJava/
137117
$ ./gradlew build
138118
```

0 commit comments

Comments
 (0)