v3.0.0 release

Author: ashish-cisco

README.md

@@ -1,41 +1,52 @@
-## Webex Connect Android SDK 
+# Webex Connect Android SDK
 
 Webex Connect Android SDK provides a messaging framework that enables app developers to embed bidirectional in-app messaging and interactive push notifications capabilities within their mobile applications.
 
-## Core SDK Flavours:	 
+## v3.x.x Modularized SDKs
 
- - Full SDK: Webex Connect Core SDK - Full 
+We have introduced new modularized SDKs in version 3.0.0, each designed to offer specific functionality. Please follow the below table to get more details of each module and its functionality. This will help you to understand what's available in each module and decide which modules you want to integrate into your applications.
 
-     - This SDK supports Live Chat / In-App and Push Messaging capabilities.
+| **Module** | **Description** |
+| --- | --- |
+| webexconnect-core<br>(Mandatory) | The core module is the foundation of the Webex Connect SDK. It provides essential functionality that all other modules depend on, including initialization, configuration, registration, and shared utilities. |
+| webexconnect-push | The push module enables your application to receive and handle push notifications. It abstracts the underlying push notification service, providing customized support for notification management. |
+| webexconnect-fcm | The fcm module integrates Firebase Cloud Messaging to handle push notifications for devices with Google Play Services. |
+| webexconnect-hms | The hms module integrates Huawei Mobile Services to handle push notifications for devices with Huawei Mobile Services. |
+| webexconnect-inappmessaging | The inappmessaging module offers both one-way and two-way messaging capabilities for your app. |
 
-     - Supports all the features. 
+## v2.x.x Legacy Core SDK Flavours
 
-          - Details of all features can be found [here](https://developers.imiconnect.io/docs/sdk-vs-sdk-lite). 
-	 - In the Full SDK, you will have two SDKs, and you can integrate the SDKs based on the push provider (FCM and HMS). 
+We continue to support the old SDKs alongside the new modularized versions.
 
- - Lite SDK: Webex Connect Core SDK - Lite 
+- Full SDK: Webex Connect Core SDK - Full
+    - This SDK supports Live Chat / In-App and Push Messaging capabilities.
+    - Supports all the features.
+        - Details of all features can be found [here](https://developers.webexconnect.io/docs/sdk-vs-sdk-lite).
+    - In the Full SDK, you will have two SDKs, and you can integrate the SDKs based on the push provider (FCM and HMS).
+- Lite SDK: Webex Connect Core SDK - Lite
+    - This SDK supports Live Chat / In-App and Push (FCM and HMS) Messaging capabilities.
+    - It does not support device attribute monitoring capability.
+        - Details of all features can be found [here.](https://developers.webexconnect.io/docs/sdk-vs-sdk-lite)
+    - In the Lite SDK, you will have two SDKs, and you can integrate the SDKs based on the push provider (FCM and HMS).
 
-     - This SDK supports Live Chat / In-App and Push Messaging capabilities. 
+Both the SDKs are independent of each other. You can use either one of them depending on your use case.
 
-     - It does not support device attribute monitoring capability. 
+## Documentation References
 
-          - Details of all features can be found [here](https://developers.imiconnect.io/docs/sdk-vs-sdk-lite).
-	 - In the Lite SDK, you will have two SDKs, and you can integrate the SDKs based on the push provider (FCM and HMS).
+| **Documentation References** | **2.x** | **3.x** |
+| --- | --- | --- |
+| Overview of SDKs | [Link](https://developers.webexconnect.io/docs/overview-of-sdks)||
+| SDK Flavours / Features | [Link](https://developers.webexconnect.io/docs/sdk-vs-sdk-lite)||
+| Quick Start Guide | [Link](https://developers.webexconnect.io/docs/quickstart-guide-2) | [Link](https://developers.webexconnect.io/docs/android-modularization-sdk-quick-start-guide) |
+| SDK Migration from 2.x to 3.x | [Link](https://developers.webexconnect.io/docs/android-sdk-migration-document-from-2x-to-3x)||
 
-Both the SDKs are independent of each other. You can use either one of them depending on your use case. 
+## Support
 
-## Documentation Refences 
-
-[Overview of SDKs](https://developers.imiconnect.io/docs/overview-of-sdks)
-
-[Quick Start Guide](https://developers.imiconnect.io/docs/quickstart-guide-2)
-
-## Support 
-
-[Webex Connect Support](https://developers.imiconnect.io/docs/imiconnect-support)
+- [Webex Connect Support](https://developers.imiconnect.io/docs/imiconnect-support)
 
 ## License
+All contents are licensed under the Cisco EULA
 
-&copy; 2000-2023 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.
+See [License](https://www.cisco.com/c/en/us/products/end-user-license-agreement.html) for details.
 
-See [LICENSE](https://github.com/webex/wxconnect-core-android-sdk/blob/main/LICENSE) for details.
+© 2000 - 2024 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.