From 5586c35523eeda9b0886cb6202bb5b4e595fd3a3 Mon Sep 17 00:00:00 2001 From: Vinay Gaba Date: Tue, 19 Sep 2023 12:11:29 -0700 Subject: [PATCH] Reverts #341 and instead adds that information in the README (#354) * Revert proguard rule * Update README with information about proguard --- README.md | 8 ++++++++ showkase/consumer-rules.pro | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 204acc9c..c4497a64 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,14 @@ class MyRootModule: ShowkaseRootModule startActivity(Showkase.getBrowserIntent(context)) ``` +Most users of Showkase will use it in their debug builds. However, if you have a use case where you would +like to use Showkase in a release build (or a build that has minification enabled), you will need to add +the following line to your proguard rules + +``` +-keep public class * extends com.airbnb.android.showkase.models.ShowkaseProvider +``` + ## Documentation ##### 1. @ShowkaseComposable diff --git a/showkase/consumer-rules.pro b/showkase/consumer-rules.pro index ae41cce7..8b137891 100644 --- a/showkase/consumer-rules.pro +++ b/showkase/consumer-rules.pro @@ -1 +1 @@ --keep public class * extends com.airbnb.android.showkase.models.ShowkaseProvider +