@customerglu/react-native-customerglu 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -56
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,74 +1,30 @@
1
- # CustomerGlu
1
+ # CustomerGlu SDK
2
2
 
3
- CustomerGlu SDK provides you lots of in-built stuff and make your integration faster with CustomerGlu
4
- Our SDK provides you In-built functions you just need to use them.
3
+ CustomerGlu SDK provides you Express Installation requiring minimal technical effort, with out of the box methods for every functionality.
5
4
 
6
- # Prerequisite
5
+ # Pre-Requisites
7
6
 
8
- iOS - Requires IOS 11.0 or above.
7
+ ### iOS
8
+ Supports IOS 11.0+ and requires Xcode 12 or above to build.
9
9
 
10
- Xcode - Version 12.0 or above
11
-
12
- Android - Requires minSdkVersion should be 21
10
+ ### Android
11
+ Supports API 21 and above. Please ensure the minSDKVersion in the app's build.gradle file reflects the same.
13
12
 
14
13
 
15
14
  # Installation
16
15
 
17
- OPTION 1 -
16
+ ### Option 1
18
17
  Add the CustomerGlu React Native plugin in package.json file
19
18
  ```
20
- "@customerglu/react-native-customerglu": "^1.0.5"
19
+ "@customerglu/react-native-customerglu": "^1.0.6"
21
20
  ```
22
21
 
23
- OPTION 2 -
22
+ ### Option 2
24
23
  Run this command With npm:
25
24
  ```
26
25
  npm install @customerglu/react-native-customerglu
27
26
  ```
28
27
 
29
- # Initialise CustomerGlu SDK
30
-
31
- Android Setup -
32
-
33
- Firstly add the permission of internet in Manifest file.
34
- ```
35
- <uses-permission android:name="android.permission.INTERNET" />
36
- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
37
-
38
-
39
- WriteKey - Mandatory step and need to put your writeKey in meta-data .Write_key are provided by CustomerGlu
40
-
41
- <meta-data android:name="CUSTOMERGLU_WRITE_KEY" //Don't Change Name
42
- android:value="YOUR_WRITE_KEY" />
43
-
44
- ```
45
- If Proguard is enabled in your app, Add the following line in release build.
46
-
47
-
48
- buildTypes {
49
- release {
50
- // TODO: Add your own signing config for the release build.
51
- signingConfig signingConfigs.debug
52
- proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'),
53
- 'proguard-rules.pro'
54
-
55
- }
56
- }
57
-
58
- Create a Proguard rules file if not present and add the following rule in Proguard Rules file:
59
-
60
-
61
- -keep class com.customerglu.sdk.Modal.*{*;}
62
-
63
- iOS Setup -
64
-
65
- Mandatory step and need to put CustomerGlu WRITE_KEY in Info.plist
66
- ```
67
- <key>CUSTOMERGLU_WRITE_KEY</key>
68
- <string>YOUR_WRITE_KEY</string>
69
-
70
- ```
71
-
72
- # Functionalities
28
+ # Initialisation & Functionalities
73
29
 
74
- Please refer to the [React Native Docs](https://docs.customerglu.com/sdk/react-native)
30
+ Please refer to the [Documentation here](https://docs.customerglu.com/sdk/mobile-sdks#react-native)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@customerglu/react-native-customerglu",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "description": "CustomerGlu React Native plugin",
5
5
  "main": "lib/commonjs/index",
6
6
  "module": "lib/module/index",