Skip to content

Commit 2fdf973

Browse files
Add migration notes to READMEs.
- Fix examples. - Do not link to unrelated example, it's confusing.
1 parent 8093b80 commit 2fdf973

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

objectbox-rxjava/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
:information_source: This library will receive no new features.
2+
Development will continue with the [RxJava 3 APIs for ObjectBox](/objectbox-rxjava3).
3+
14
RxJava 2 APIs for ObjectBox
25
===========================
36
While ObjectBox has [data observers and reactive extensions](https://docs.objectbox.io/data-observers-and-rx) built-in,
@@ -13,7 +16,7 @@ For general object changes, you can use `RxBoxStore` to create an `Observable`.
1316
For example to get query results and subscribe to future updates (Object changes will automatically emmit new data):
1417

1518
```java
16-
Query query = box.query().build();
19+
Query<User> query = box.query().build();
1720
RxQuery.observable(query).subscribe(this);
1821
```
1922

@@ -27,5 +30,3 @@ implementation "io.objectbox:objectbox-rxjava:$objectboxVersion"
2730
Links
2831
-----
2932
[Data Observers and Rx Documentation](https://docs.objectbox.io/data-observers-and-rx)
30-
31-
[Note App example](https://github.com/objectbox/objectbox-examples/blob/master/objectbox-example/src/main/java/io/objectbox/example/ReactiveNoteActivity.java)

objectbox-rxjava3/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For general object changes, you can use `RxBoxStore` to create an `Observable`.
1313
For example to get query results and subscribe to future updates (Object changes will automatically emmit new data):
1414

1515
```java
16-
Query query = box.query().build();
16+
Query<User> query = box.query().build();
1717
RxQuery.observable(query).subscribe(this);
1818
```
1919

@@ -24,8 +24,16 @@ Grab via Gradle:
2424
implementation "io.objectbox:objectbox-rxjava3:$objectboxVersion"
2525
```
2626

27+
Migrating from RxJava 2
28+
-----------------------
29+
30+
If you have previously used the ObjectBox RxJava library note the following changes:
31+
32+
- The location of the dependency has changed to `objectbox-rxjava3` (see above).
33+
- The package name has changed to `io.objectbox.rx3` (from `io.objectbox.rx`).
34+
35+
This should allow using both versions side-by-side while you migrate your code to RxJava 3.
36+
2737
Links
2838
-----
2939
[Data Observers and Rx Documentation](https://docs.objectbox.io/data-observers-and-rx)
30-
31-
[Note App example](https://github.com/objectbox/objectbox-examples/blob/master/objectbox-example/src/main/java/io/objectbox/example/ReactiveNoteActivity.java)

0 commit comments

Comments
 (0)