Skip to content

Commit b29508a

Browse files
Note on versioning on road to 1.0
1 parent 44a8420 commit b29508a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@ Learn more about Rx on the <a href="https://github.com/Netflix/RxJava/wiki">Wiki
2424

2525
<a href='https://netflixoss.ci.cloudbees.com/job/RxJava-pull-requests/'><img src='https://netflixoss.ci.cloudbees.com/job/RxJava-pull-requests/badge/icon'></a>
2626

27+
## Versioning
28+
29+
RxJava is working towards a 1.0 release which will be reached once it "more or less" becomes feature complete with the [Rx.Net version](https://rx.codeplex.com). The backlog of features needed to accomplish this are documented in the [project issues](https://github.com/Netflix/RxJava/issues).
30+
31+
In short, once the current issue list hits 0 open we will bump to version 1.0.
32+
33+
Until that time the "semantic versioning" will be prefixed with the 0.* and breaking changes will be done such as 0.5.x -> 0.6.x All incremental non-breaking changes with additive functionality will be done like 0.5.1 -> 0.5.2.
34+
35+
Once we hit 1.0 it will follow the normal major.minor.patch semantic versioning approach.
36+
2737
## Full Documentation
2838

2939
- [Wiki](https://github.com/Netflix/RxJava/wiki)
@@ -49,13 +59,13 @@ Example for Maven:
4959
<dependency>
5060
<groupId>com.netflix.rxjava</groupId>
5161
<artifactId>rxjava-core</artifactId>
52-
<version>0.5.0</version>
62+
<version>x.y.z</version>
5363
</dependency>
5464
```
5565
and for Ivy:
5666

5767
```xml
58-
<dependency org="com.netflix.rxjava" name="rxjava-core" rev="0.5.0" />
68+
<dependency org="com.netflix.rxjava" name="rxjava-core" rev="x.y.z" />
5969
```
6070

6171
If you need to download the jars instead of using a build system, create a Maven pom file like this with the desired version:
@@ -73,7 +83,7 @@ If you need to download the jars instead of using a build system, create a Maven
7383
<dependency>
7484
<groupId>com.netflix.rxjava</groupId>
7585
<artifactId>rxjava-core</artifactId>
76-
<version>0.5.0</version>
86+
<version>x.y.z</version>
7787
<scope/>
7888
</dependency>
7989
</dependencies>

0 commit comments

Comments
 (0)