Skip to content

Commit 99bf8e9

Browse files
authored
Merge pull request #103 from joshdholtz/feature-docs
Improve readme
2 parents ddfbc42 + cb2db13 commit 99bf8e9

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,46 @@ public class MainActivity extends Activity {
2424
}
2525
```
2626

27+
## Features
28+
29+
Sentry-Android has two features that make it easy to use.
30+
31+
First, Sentry-Android will, by default, install an uncaught exception handler
32+
that will catch and report any uncaught exceptions (crashes) in your app. You
33+
only need to add a single line of code to set up Sentry-Android.
34+
35+
Second, since Sentry-Android is written specifically for Android, we can
36+
automatically associate device and OS information to error-reports. The
37+
table below shows an example of what the data will look like in Sentry.
38+
39+
<table>
40+
41+
<thead><tr><th colspan="2">DEVICE</th></tr></thead>
42+
<tbody>
43+
<tr><td>Family</td><td>google</td></tr>
44+
<tr><td>Model</td><td>bullhead (Nexus 5X)</td></tr>
45+
<tr><td>Architecture</td><td>aarch64</td></tr>
46+
<tr><td>Orientation</td><td>portrait</td></tr>
47+
<tr><td>screen_resolution</td><td>1794x1080</td></tr>
48+
</tbody>
49+
50+
<thead><tr><th colspan="2">OPERATING SYSTEM</th></tr></thead>
51+
<tbody>
52+
<tr><td>Name</td><td>Android</td></tr>
53+
<tr><td>Version</td><td>7.0 (24)</td></tr>
54+
<tr><td>Kernel Version</td><td>3.10.73-g76d746e</td></tr>
55+
</tbody>
56+
57+
<thead><tr><th colspan="2">PACKAGE</th></tr></thead>
58+
<tbody>
59+
<tr><td>name</td><td>com.example.package</td></tr>
60+
<tr><td>version_code</td><td>210</td></tr>
61+
<tr><td>version_name</td><td>2.1</td></tr>
62+
</tbody>
63+
64+
</table>
65+
66+
2767
### Updates
2868

2969
Version | Changes

0 commit comments

Comments
 (0)