Skip to content

Commit 762ed0c

Browse files
author
breensmbaka
committed
Update instructions when minification is enabled for release build apps that use the library
1 parent 927bfe9 commit 762ed0c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ dependencies {
5353
}
5454
```
5555

56+
# Usage
57+
5658
- Import the library: Import the BeeTablesCompose function into your Compose-based project.
5759

5860
- Prepare your data: Organize your data in a list of objects to be displayed in the table.
@@ -66,6 +68,17 @@ dependencies {
6668
<p align="center">
6769
<img src="https://github.com/Breens-Mbaka/BeeTablesCompose/assets/72180010/f5ea94a1-df41-472c-91e2-03d6cb7dc82f" />
6870

71+
# NOTE ⚠️🚨
72+
- Before building a release APK of your app, if you have enabled minification, make sure to annotate your table data classes with @Keep. This will prevent the class from being removed at runtime.
73+
```kotlin
74+
@Keep
75+
data class User(
76+
val name: String,
77+
val email: Int,
78+
val city: String
79+
)
80+
```
81+
6982
# Want a new shiny feature 🪩✨
7083
- If you want to request a new feature please first read this [short guide](https://github.com/Breens-Mbaka/BeeTablesCompose/blob/master/.github/ISSUE_TEMPLATE/feature_request.md)
7184

0 commit comments

Comments
 (0)