Skip to content

Commit 16e29c4

Browse files
authored
Update README.md
1 parent 0200664 commit 16e29c4

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,25 @@
44

55
A library to make StackTraces involving RxJava2 more meaningful (they will always point to your code!).
66

7-
# Releases
7+
# Rationale
88

9-
**gradle**
9+
If you use RxJava2, you know the pain of debugging exceptions generated somwhere across the stream, in another thread, in a nested stream, ... The StackTrace provided by RxJava2 will tell you almost nothing. Even more, if you are using systems like Crashlytics to collect reports for and Android app, most RxJava-related crashes will be reported as a single error instance (omg, no way to fix that).
1010

11-
```groovy
12-
repositories {
13-
jcenter()
14-
}
15-
```
11+
This library was created from the need to debug such situations when they happen in Android apps; even more, I needed to have a clear and precise report in Crashlytics for each distinct exception.
12+
13+
1. If you handle exceptions generated in RxJava2 streams, you can query RxJava2Debug to obtain an extended StackTrace pointing to the exact line of code that created the issue.
14+
15+
2. If you let exceptions generated in RxJava2 streams crash your app, RxJava2Debug will automatically extend the default StackTrace.
16+
17+
3. If you let exceptions generated in RxJava2 streams crash your app and you configure RxJava2Debug with your package-names, RxJava2Debug will make sure you get unique reports for each issue (to Crashlytics, or whichever reporting system you use).
18+
19+
20+
# Releases
1621

1722
```groovy
1823
repositories {
24+
// You can use jcenter() or mavenCentral(), any of them will work great
25+
jcenter()
1926
mavenCentral()
2027
}
2128
```
@@ -199,4 +206,4 @@ Instead of getting a multitude of reports involving RxJava2 into a single report
199206

200207
This library is using a subset of classes from [akarnokd's RxJava2Extensions](https://github.com/akarnokd/RxJava2Extensions).
201208

202-
RxJava2Extensions takes about `kb` and contains `` methods. RxJava2Debug takes about `38kb` and contains `` methods.
209+
RxJava2Extensions takes about `kb` and contains `` methods. RxJava2Debug takes about `38kb` and contains `` methods.

0 commit comments

Comments
 (0)