From f3fdab13de2bbc4be4fe434d68b4e353bb70c5aa Mon Sep 17 00:00:00 2001 From: Jeff Ward Date: Fri, 5 Jul 2024 09:53:25 -0400 Subject: [PATCH] Add uploading section to README. --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b52e9e..0f78102 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.