From baf47e7f49195d209427b8a1349fc8fb939ddebb Mon Sep 17 00:00:00 2001 From: littleGnAl Date: Mon, 12 Aug 2024 15:56:25 +0800 Subject: [PATCH] First commit for RTM 2.x --- README.md | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 0caf582..82fb6fd 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ This Flutter plugin is a wapper for [Agora RTM SDK](https://docs.agora.io/en). Agora.io provides building blocks for you to add real-time messaging through a simple and powerful SDK. You can integrate the Agora RTM SDK to enable real-time messaging in your own application quickly. -*Note*: This plugin is still under development, and some APIs might not be available yet. +> NOTE: The `main` branch is major update base on the Agora RTM SDK 2.x, which introduces some break changes. previous releases please see the following branches(the version < 2.x): +> +> - [1.x](https://github.com/AgoraIO-Extensions/Agora-Flutter-RTM-SDK/tree/master) ## Usage @@ -27,35 +29,11 @@ To use this plugin, add `agora_rtm` as a [dependency in your pubspec.yaml file]( * See the [example](example) directory for a sample app using AgoraRtm. -## Error handling +## Feedback -### Kotlin version +If you have any problems or suggestions regarding the sample projects, feel free to file an [issue](https://github.com/AgoraIO-Extensions/Agora-Flutter-RTM-SDK/issues) OR pull request. -if your version less than 0.9.9, remove `ext.kotlin_version = '1.3.0'` from `agora_rtm/build.gradle` - -from 0.9.9, the plugin will use your root project kotlin version, make sure your setting is correct - -### Release crash - -it causes by code obfuscation because of flutter set `android.enableR8=true` by the default - -Add the following line in the **app/proguard-rules.pro** file to prevent code obfuscation: -``` --keep class io.agora.**{*;} -``` - -## Note - -### Flutter 1.12 - -if your MainActivity extends `io.flutter.embedding.android.FlutterActivity` - -please remove this line -``` -GeneratedPluginRegistrant.registerWith(this) -``` - -[you can refer to official documents](https://flutter.dev/docs/development/packages-and-plugins/plugin-api-migration) +For urgent issues, please submit a ticket to [Agora Support](https://www.agora.io/en/customer-support/) to receive a timely response. ## How to contribute