From fa37d4cab81edc1a285f0372dc3a7ea536fdd03d Mon Sep 17 00:00:00 2001 From: Vinay Gaba Date: Tue, 19 Sep 2023 10:50:51 -0700 Subject: [PATCH] Update README with information about proguard --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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