Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update README.md about proguard #45

Merged
merged 6 commits into from
May 18, 2024
Merged

doc: Update README.md about proguard #45

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7c3c37
doc: Update README.md about proguard
idrakimuhamad May 17, 2024
7c1bcaf
doc: move the section under installation
idrakimuhamad May 17, 2024
318a758
doc: move back proguard section to after the API and provide anchor t…
idrakimuhamad May 17, 2024
fd5a18e
Update README.md
idrakimuhamad May 17, 2024
ee80736
doc: update grammar
idrakimuhamad May 17, 2024
852d820
doc: added colon
idrakimuhamad May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
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 build, check out the [note.](#android)
idrakimuhamad marked this conversation as resolved.
Show resolved Hide resolved

### 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 at `proguard-rules.pro`
idrakimuhamad marked this conversation as resolved.
Show resolved Hide resolved

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

# for skottie
-keep class com.skiaskottie.** { *; }
```

idrakimuhamad marked this conversation as resolved.
Show resolved Hide resolved
### Community Discord

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