Skip to content

Commit

Permalink
Add uploading section to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
fuzzybinary committed Jul 5, 2024
1 parent 22853c3 commit f3fdab1
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Gradle Plugin for Datadog Android SDK

> This plugin is used to upload your Proguard/Dexguard/R8 mapping files to Datadog to get a complete RUM Error Tracking experience.
> This plugin is used to upload your Proguard/Dexguard/R8 mapping files and NDK symbol files to Datadog to get a complete RUM Error Tracking experience.
Once your mapping file are uploaded, any error/crash reported through RUM will have a deobfuscated stacktrace, enabling an easy diagnosis of the root cause of the error.
Once your mapping file are uploaded, any error/crash reported through RUM will have a deobfuscated and symbolicated stacktrace, enabling an easy diagnosis of the root cause of the error.

## Getting Started

Expand All @@ -16,6 +16,20 @@ plugins {
}
```

### Uploading

To upload your mapping files to Datadog, run the `uploadMapping[Variant]` task in your Android project as part of your build or after your build, for example:

```bash
./gradlew uploadMappingRelease
```

Similarly, to upload NDK symbols, run the `uploadNdkSymbolFiles[Variant]` task in your Android project. For example:

```bash
./gradlew uploadNdkSymbolFilesRelease
```

### Configuration

You can configure the plugin by adding the following block at the end of your `build.gradle` file.
Expand Down

0 comments on commit f3fdab1

Please sign in to comment.