Skip to content

Commit

Permalink
doc: Update README.md about proguard (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
idrakimuhamad authored May 18, 2024
1 parent f26802b commit ed31fa2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ We benchmarked react-native-skottie against [lottie-react-native](https://github
yarn add react-native-skottie
```

For Android release builds, check out the [note.](#android)

### Usage

```tsx
Expand Down Expand Up @@ -208,6 +210,20 @@ played. The API is of type `SkottieAPI` and provides the following methods:
|-----------------------|----------------------------------------------------------------------|
| SkottieAPI.createFrom | Creates a Skottie instance from a source (string, json, file import) |

### Android

#### Proguard

If you're using Proguard, make sure to add the following rule in `proguard-rules.pro`:

```
# for skia, if you haven't add it
-keep class com.shopify.reactnative.skia.** { *; }
# for skottie
-keep class com.skiaskottie.** { *; }
```

### Community Discord

[Join the Margelo Community Discord](https://discord.gg/6CSHz2qAvA) to chat about react-native-skottie or other Margelo libraries.
Expand Down

0 comments on commit ed31fa2

Please sign in to comment.