From 137080ad2c7c28e573d71f9579421a4b2cd2c71f Mon Sep 17 00:00:00 2001
From: Jinny You <jinny@lottiefiles.com>
Date: Sun, 17 Mar 2024 21:59:25 +0900
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add known issues
---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index a4a9376..a5387f0 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,36 @@ class MyApp extends StatelessWidget {
 }
 ```
 
+## Known Issues
+
+> [!WARNING]  
+> As an experimental project, we anticipate the following issues may render the use of this library unstable. Please verify before using `lottie-thorvg`.
+
+### iOS
+
+#### Unexpected white background rendered ([#2](https://github.com/tinyjin/lottie-thorvg/issues/2))
+
+This seems to be appeared by the Impeller renderer, affecting rendered canvas that has unexpected white background.
+
+**Workaround**:
+- Open `Info.plist`
+- Turn off Impeller by adding:
+  ```plist
+  <key>FLTEnableImpeller</key>
+  <false/>
+  ```
+
+#### Apple Silicon simulator build error ([#4](https://github.com/tinyjin/lottie-thorvg/issues/4))
+
+Currently, ThorVG Flutter iOS binding operates with a dylib. To support universal dynamic library, We should transition to using xcframework. However `dart-ffi` faces an issue where it can't open dynamic libraries through the xcframework.
+
+It only triggers an error when buliding on iOS Simulator under Apple Silicon.
+
+**Workaround**:
+- If you're using mac OS(Intel), no effects
+- Do use iOS Simulator by rosetta
+  It won't effect to real device & store uploading
+
 # License
 
 MIT
\ No newline at end of file