Skip to content

Commit e28e32f

Browse files
committed
Update README to let users know about the codemod
1 parent 86c7163 commit e28e32f

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,33 @@
77

88
## About
99

10-
RxDart adds additional capabilities to Dart [Streams](https://api.dart.dev/stable/dart-async/Stream-class.html) and [StreamControllers](https://api.dart.dev/stable/dart-async/StreamController-class.html).
10+
RxDart adds additional capabilities to Dart
11+
[Streams](https://api.dart.dev/stable/dart-async/Stream-class.html) and
12+
[StreamControllers](https://api.dart.dev/stable/dart-async/StreamController-class.html).
1113

12-
Dart comes with a very decent [Streams](https://api.dart.dev/stable/dart-async/Stream-class.html) API out-of-the-box; rather than attempting to provide an alternative to this API, RxDart adds functionality from the reactive extensions specification on top of it.
14+
Dart comes with a very decent
15+
[Streams](https://api.dart.dev/stable/dart-async/Stream-class.html) API
16+
out-of-the-box; rather than attempting to provide an alternative to this API,
17+
RxDart adds functionality from the reactive extensions specification on top of
18+
it.
1319

14-
RxDart does not provide its own Observable class as a replacement for Dart Streams. Rather, it provides a number of additional Stream classes, operators (extension methods on the Stream class), and Subjects.
20+
RxDart does not provide its own Observable class as a replacement for Dart
21+
Streams. Rather, it provides a number of additional Stream classes, operators
22+
(extension methods on the Stream class), and Subjects.
1523

16-
If you are familiar with Observables from other languages, please see [the Rx Observables vs Dart Streams comparison chart](#rx-observables-vs-dart-streams) for notable distinctions between the two.
24+
If you are familiar with Observables from other languages, please see [the Rx
25+
Observables vs Dart Streams comparison chart](#rx-observables-vs-dart-streams)
26+
for notable distinctions between the two.
27+
28+
## Upgrading from RxDart 0.22.x to 0.23.x
29+
30+
RxDart 0.23.x moves away from the Observable class, utilizing Dart 2.6's new
31+
extension methods instead. This requires several small refactors that can be
32+
easily automated -- which is just what we've done!
33+
34+
Please follow the instructions on the
35+
[rxdart_codemod](https://pub.dev/packages/rxdart_codemod) package to
36+
automatically upgrade your code to support RxDart 0.23.x.
1737

1838
## How To Use RxDart
1939

0 commit comments

Comments
 (0)