diff --git a/README.md b/README.md
index 745d1eba7..b66896fec 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,24 @@
-# agora_rtc_engine
+# Agora RTC SDK for Flutter
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+
+ 
+
+
+
-
[中文](README.zh.md)
-This Flutter plugin is a wrapper
-for [Agora Video SDK](https://docs.agora.io/en/Interactive%20Broadcast/product_live?platform=All%20Platforms)
-.
+> This Flutter plugin is a wrapper for [Agora Video SDK](https://docs.agora.io/en/Interactive%20Broadcast/product_live?platform=All%20Platforms)
-Agora.io provides building blocks for you to add real-time voice and video communications through a
-simple and powerful SDK. You can integrate the Agora SDK to enable real-time communications in your
-own application quickly.
+Agora.io provides building blocks for you to add real-time voice and video communications through a simple and powerful SDK. You can integrate the Agora SDK to enable real-time communications in your own application quickly.
## Usage
@@ -61,10 +69,7 @@ Open the `Info.plist` and add:
### Null Safety
-We have supported null safety at
-the [4.0.1](https://pub.dev/packages/agora_rtc_engine/versions/4.0.1) version already. This version
-is not downward compatible, your project needs to be migrated to null safety, please refer
-to [Migrating to null safety](https://dart.dev/null-safety/migration-guide).
+Null safety is supported from [4.0.1](https://pub.dev/packages/agora_rtc_engine/versions/4.0.1) version. This version is not backwards compatible, your project needs to be migrated to null safety. For more information, please refer to [Migrating to null safety](https://dart.dev/null-safety/migration-guide).
### Multiple Platforms
@@ -74,63 +79,42 @@ Not support yet.
#### macOS
-You can get more info from the [agora_rtc_engine.podspec](macos/agora_rtc_engine.podspec) file, such
-as dependency Libraries on macOS.
+You can get more info from the [agora_rtc_engine.podspec](macos/agora_rtc_engine.podspec) file, such as dependency Libraries on macOS.
#### Windows
-You can get more info from the [CMakeLists.text](windows/CMakeLists.txt) file, such as dependency
-Libraries on Windows.
+You can get more info from the [CMakeLists.text](windows/CMakeLists.txt) file, such as dependency Libraries on Windows.
#### Web
We use the [js](https://pub.dev/packages/js) library to call JavaScript from the dart layer.
-We have a wrapper library named [AgoraRtcWrapper.bundle.js](example/web/AgoraRtcWrapper.bundle.js)
-for the Web SDK, so you should add it to your `index.html`, you can refer
-to [example/web/index.html](example/web/index.html).
+We have a wrapper library named [AgoraRtcWrapper.bundle.js](example/web/AgoraRtcWrapper.bundle.js) for the Web SDK, so you should add it to your `index.html`, you can refer to [example/web/index.html](example/web/index.html).
```html
-
```
-This wrapper library is the output of the open-source
-repository [Iris-Rtc-Web](https://github.com/AgoraIO-Community/Iris-Rtc-Web). The repository attempt
-to mapping the API from Web SDK as Native SDK, we make it open-source to help developer positioning
-and troubleshooting.
+This wrapper library is the output of the open-source repository [Iris-Rtc-Web](https://github.com/AgoraIO-Community/Iris-Rtc-Web). The repository attempt to mapping the API from Web SDK as Native SDK, we make it open-source to help developer positioning and troubleshooting.
We have imported it as a Git submodule, you can find it in the [web](web) folder.
## Interact with RtcEngine/AgoraRtcEngineKit on Android/iOS
-`agora_rtc_engine` has not implemented all the features of agora native (Android/iOS) sdk, due to
-performance reasons, such
-as [Custom Audio Source and Renderer](https://docs.agora.io/en/Video/custom_audio_android?platform=Android)
-, [Custom Video Source and Renderer](https://docs.agora.io/en/Video/custom_video_android?platform=Android)
-, [Raw Audio Data](https://docs.agora.io/en/Video/raw_data_audio_android?platform=Android),
-etc. `agora_rtc_engine`
-provides [RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/android/src/main/java/io/agora/rtc/base/RtcEnginePlugin.kt)/[RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/ios/Classes/Base/RtcEnginePlugin.h)
-, allowing you to to interact with
-the [RtcEngine](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/lib/src/rtc_engine.dart)
-created on the Flutter side in the Android/iOS code, you can implement your own plugin by
-inheriting [RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/android/src/main/java/io/agora/rtc/base/RtcEnginePlugin.kt)/[RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/ios/Classes/Base/RtcEnginePlugin.h)
-, and get
-the [RtcEngine](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html)/[AgoraRtcEngineKit](https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html)
-in the `onRtcEngineCreated` callback. Please note that you should not call
-the [RtcEngine.destroy](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#afb808cdc9025a77af7dd2bce98311bfe)/[AgoraRtcEngineKit.destroy](https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/destroy)
-function on Android/iOS code, because it will affect
-the [RtcEngine](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/lib/src/rtc_engine.dart) on
-the Flutter side. To see how to use `RtcEnginePlugin`, please check the custom audio source example:
-
-Android：[CustomAudioPlugin.kt](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/example/android/app/src/main/kotlin/io/agora/agora_rtc_engine_example/custom_audio_source/CustomAudioPlugin.kt)
-
-iOS：[CustmoAudioSourcePlugin.swift](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/example/ios/Runner/CustomAudioSource/CustmoAudioSourcePlugin.swift)
+`agora_rtc_engine` has not implemented all the features of agora native (Android/iOS) sdk, due to performance reasons, such
+as [Custom Audio Source and Renderer](https://docs.agora.io/en/Video/custom_audio_android?platform=Android), [Custom Video Source and Renderer](https://docs.agora.io/en/Video/custom_video_android?platform=Android), [Raw Audio Data](https://docs.agora.io/en/Video/raw_data_audio_android?platform=Android), etc.
+
+`agora_rtc_engine` provides [RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/android/src/main/java/io/agora/rtc/base/RtcEnginePlugin.kt)/[RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/ios/Classes/Base/RtcEnginePlugin.h), allowing you to to interact with the [RtcEngine](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/lib/src/rtc_engine.dart) created on the Flutter side in the Android/iOS code, you can implement your own plugin by inheriting [RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/android/src/main/java/io/agora/rtc/base/RtcEnginePlugin.kt)/[RtcEnginePlugin](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/ios/Classes/Base/RtcEnginePlugin.h), and get the [RtcEngine](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html)/[AgoraRtcEngineKit](https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html) in the `onRtcEngineCreated` callback.
+
+Please note that you should not call the [RtcEngine.destroy](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#afb808cdc9025a77af7dd2bce98311bfe)/[AgoraRtcEngineKit.destroy](https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/destroy) function on Android/iOS code, because it will affect the [RtcEngine](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/lib/src/rtc_engine.dart) on the Flutter side. To see how to use `RtcEnginePlugin`, please check the custom audio source example:
+
+Android: [CustomAudioPlugin.kt](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/example/android/app/src/main/kotlin/io/agora/agora_rtc_engine_example/custom_audio_source/CustomAudioPlugin.kt)
+
+iOS: [CustmoAudioSourcePlugin.swift](https://github.com/AgoraIO/Agora-Flutter-SDK/blob/master/example/ios/Runner/CustomAudioSource/CustmoAudioSourcePlugin.swift)
## Error handling
-Please check **Pinned issues** and search
-in [Issues](https://github.com/AgoraIO/Agora-Flutter-SDK/issues) first.
+Please check **Pinned issues** and search in [Issues](https://github.com/AgoraIO/Agora-Flutter-SDK/issues) first.
### [Background mode #28](https://github.com/AgoraIO/Agora-Flutter-SDK/issues/28)
@@ -140,56 +124,49 @@ in [Issues](https://github.com/AgoraIO/Agora-Flutter-SDK/issues) first.
#### iOS
-Select your **TARGET** in Xcode, and click the `Signing & Capabilities` tab, then
-enable `Background Modes` and check `Audio, AirPlay, and Picture in Picture`.
+Select your **TARGET** in Xcode, and click the `Signing & Capabilities` tab, then enable `Background Modes` and check `Audio, AirPlay, and Picture in Picture`.
### [RawData #183](https://github.com/AgoraIO/Agora-Flutter-SDK/issues/183)
-Only support Android and iOS yet.
+Currently supported for Android and iOS.
### [Using flutter assets #181](https://github.com/AgoraIO/Agora-Flutter-SDK/issues/181)
### Screen Sharing
-Only support Web, macOS and Windows yet, not support for Android and iOS.
+Only supported on Web, macOS and Windows so far. Not yet supported for Android and iOS.
**Important**
You should set `AppGroup` on macOS and set as parameter before calling `getScreenShareHelper`.
-You can refer
-to [screen_sharing.dart](example/lib/examples/advanced/screen_sharing/screen_sharing.dart)
-and [Apple doc](https://developer.apple.com/library/archive/documentation/Security/Conceptual/AppSandboxDesignGuide/AppSandboxInDepth/AppSandboxInDepth.html#//apple_ref/doc/uid/TP40011183-CH3-SW21)
+You can refer to [screen_sharing.dart](example/lib/examples/advanced/screen_sharing/screen_sharing.dart) and [Apple doc](https://developer.apple.com/library/archive/documentation/Security/Conceptual/AppSandboxDesignGuide/AppSandboxInDepth/AppSandboxInDepth.html#//apple_ref/doc/uid/TP40011183-CH3-SW21).
-## API
+## API Reference Resources
-* [Flutter API](https://docs.agora.io/en/Video/API%20Reference/flutter/index.html)
-* [Android API](https://docs.agora.io/en/Video/API%20Reference/java/index.html)
-* [iOS/Mac API](https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)
-* [Windows API](https://docs.agora.io/en/Video/API%20Reference/cpp/index.html)
-* [Web API](https://docs.agora.io/en/Video/API%20Reference/web_ng/index.html)
+* [Flutter](https://docs.agora.io/en/Video/API%20Reference/flutter/index.html)
+* [Android](https://docs.agora.io/en/Video/API%20Reference/java/index.html)
+* [iOS/macOS](https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)
+* [Windows](https://docs.agora.io/en/Video/API%20Reference/cpp/index.html)
+* [Web](https://docs.agora.io/en/Video/API%20Reference/web_ng/index.html)
+* [React Native](https://docs.agora.io/en/Video/API%20Reference/react_native/index.html)
## Feedback
-If you have any problems or suggestions regarding the sample projects, feel free to file
-an [issue](https://github.com/AgoraIO/Agora-Flutter-SDK/issues).
+If you have any problems or suggestions regarding the sample projects, feel free to file an [issue](https://github.com/AgoraIO/Agora-Flutter-SDK/issues).
## How to contribute
-To help work on this sdk, please refer
-to [CONTRIBUTING.md](https://github.com/AgoraIO/Flutter-SDK/blob/master/CONTRIBUTING.md).
+To help work on this sdk, please refer to [CONTRIBUTING.md](https://github.com/AgoraIO/Flutter-SDK/blob/master/CONTRIBUTING.md).
## Related resources
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded.
-- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials
-- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use
- case
-- Repositories managed by developer communities can be found
- at [Agora Community](https://github.com/AgoraIO-Community)
-- If you encounter problems during integration, feel free to ask questions
- in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io)
+- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials.
+- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case.
+- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community).
+- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
## License
-The sample projects are under the MIT license.
+The sample projects are under the [MIT license](https://github.com/AgoraIO/Flutter-SDK/blob/master/LICENSE).
diff --git a/README.zh.md b/README.zh.md
index db24f8774..ba883b7fb 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -1,6 +1,17 @@
# agora_rtc_engine
-
+
+
+
+
+
+
+
+
+
+
+
+
[English](README.md)