Merge pull request #4 from CleverTap/develop

Release: Signed Call React Native v0.0.1

Author: Sonal-Kachare

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+
+## Version 0.0.1 (March 28, 2023)
+
+- Initial Release.
+- Supports Signed Call Android SDK v0.0.1 and Signed Call iOS SDK v0.0.2.

CODE_OF_CONDUCT.md

@@ -1,20 +1,9 @@
-MIT License
+Copyright (c) 2014-2023 CleverTap
+All rights reserved.
 
-Copyright (c) 2022 CleverTap
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+* Use of source code or binaries contained within CleverTap's Signed Call React SDK is permitted only to enable use of the CleverTap platform by customers of CleverTap.
+* Modification of source code and inclusion in mobile apps is explicitly allowed provided that all other conditions are met.
+* Neither the name of CleverTap nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+* Redistribution of source code or binaries is disallowed except with specific prior written permission. Any such redistribution must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CONTRIBUTING.md

@@ -1,31 +1,42 @@
-# clevertap-signed-call-react-native
+# CleverTap Signed Call React Native SDK
 
-CleverTap Signed Call React Native SDK.
+[![npm version](https://badge.fury.io/js/clevertap-signed-call-react-native.svg)](https://badge.fury.io/js/clevertap-signed-call-react-native)
+<a href="https://github.com/CleverTap/clevertap-signed-call-react-native-sdk/releases">
+<img src="https://img.shields.io/github/release/CleverTap/clevertap-signed-call-react-native-sdk.svg" />
+</a>
+[![npm downloads](https://img.shields.io/npm/dm/clevertap-signed-call-react-native-sdk.svg)](https://www.npmjs.com/package/clevertap-signed-call-react-native-sdk)
 
-## Installation
+## 👋 Introduction
 
-```sh
-npm install clevertap-signed-call-react-native
-```
+The CleverTap's Signed Call React Native SDK provides an in-app calls service to make and receive calls in the mobile apps if the device has an internet connection and Signed Call React Native SDK.
+
+To know more about the Signed Call feature, refer to [Signed Call](https://docs.clevertap.com/docs/signed-call).
+
+To get started, sign up [here](https://clevertap.com/live-product-demo/).
 
-## Usage
+## 🚀 Install and Integration
 
-```js
-import { multiply } from 'clevertap-signed-call-react-native';
+- To add the **CleverTap Signed Call React Native SDK** to your project, run below command on terminal:
+
+```text
+npm install @clevertap/clevertap-signed-call-react-native
+```
 
-// ...
+- Now, in your TypeScript or JavaScript code, you can use:
 
-const result = await multiply(3, 7);
+```javascript
+import SignedCall from 'clevertap-signed-call-react-native';
 ```
 
-## Contributing
+## 📑 Documentation & Example
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+- Checkout our [Technical Documentation](https://developer.clevertap.com/docs/signed-call-react-native-sdk) for instructions on integrating Signed Call into your React Native app.
+- Checkout our [Example React Native project](./example).
 
-## License
+## 🆕 Changelog
 
-MIT
+Refer to the [Signed Call React Native SDK Change Log](./CHANGELOG.md).
 
----
+## ❓Questions
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+If you have questions or concerns, you can reach out to the CleverTap support team from the CleverTap Dashboard.

LICENSE

@@ -71,6 +71,14 @@ dependencies {
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+  //Required dependencies for Signed Call Android SDK
+  implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
+  compileOnly "com.clevertap.android:clevertap-android-sdk:4.6.8"
+  compileOnly "com.clevertap.android:clevertap-signedcall-sdk:0.0.1"
+  compileOnly 'androidx.work:work-runtime:2.7.1'
+  compileOnly('io.socket:socket.io-client:2.1.0') {
+    exclude group: 'org.json', module: 'json'
+  }
 }
 
 if (isNewArchitectureEnabled()) {

README.md

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists