Skip to content

Commit a5f242b

Browse files
aniravi24fabriziomoscon
authored andcommitted
readme updates for RN 0.60 autolink
1 parent ced05c9 commit a5f242b

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

README.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# react-native-twilio-programmable-voice
2-
This is a React Native wrapper for Twilio Programmable Voice SDK that lets you make and receive calls from your ReactNatvie App. This module is not curated nor maintained, but inspired by Twilio.
2+
3+
This is a React Native wrapper for Twilio Programmable Voice SDK that lets you make and receive calls from your React Native App. This module is not affiliated with or maintained by the Twilio team. This is maintained by contributions from the community.
34

45
# Twilio Programmable Voice SDK
56

@@ -47,7 +48,9 @@ ReactNative success is directly linked to its module ecosystem. One way to make
4748
## Installation
4849

4950
Before starting, we recommend you get familiar with [Twilio Programmable Voice SDK](https://www.twilio.com/docs/api/voice-sdk).
50-
It's easier to integrate this module into your react-native app if you follow the Quick start tutorial from Twilio, because it makes very clear which setup steps are required.
51+
It's easier to integrate this module into your react-native app if you follow the Quick start tutorial from Twilio, because it makes very clear which setup steps are required. On RN 0.60+, this module can be auto-linked (Android still requires FCM setup below).
52+
53+
### Manual Linking
5154

5255

5356
```
@@ -130,8 +133,9 @@ buildscript {
130133
131134
dependencies {
132135
...
136+
// on React Native 0.60+, this module can be auto-linked and doesn't need a manual entry here
133137
134-
compile project(':react-native-twilio-programmable-voice')
138+
implementation project(':react-native-twilio-programmable-voice')
135139
}
136140
137141
// this plugin looks for google-services.json in your project
@@ -158,22 +162,12 @@ In your `AndroidManifest.xml`
158162
</intent-filter>
159163
</service>
160164
<!-- [END fcm_listener] -->
161-
<!-- [START instanceId_listener] -->
162-
<service
163-
android:name="com.hoxfon.react.RNTwilioVoice.fcm.VoiceFirebaseInstanceIDService"
164-
android:exported="false">
165-
<intent-filter>
166-
<action android:name="com.google.android.gms.iid.InstanceID" />
167-
</intent-filter>
168-
</service>
169-
<!-- [END instanceId_listener] -->
170-
<!-- Twilio Voice -->
171165

172166
.....
173167

174168
```
175169

176-
In `android/settings.gradle`
170+
In `android/settings.gradle` (not necessary if auto-linking on RN 0.60+)
177171

178172
```gradle
179173
...
@@ -182,7 +176,7 @@ include ':react-native-twilio-programmable-voice'
182176
project(':react-native-twilio-programmable-voice').projectDir = file('../node_modules/react-native-twilio-programmable-voice/android')
183177
```
184178

185-
Register module (in `MainApplication.java`)
179+
Register module (in `MainApplication.java`) (not necessary if auto-linking on RN 0.60+ unless you want to control microphone permission)
186180

187181
```java
188182
import com.hoxfon.react.RNTwilioVoice.TwilioVoicePackage; // <--- Import Package

0 commit comments

Comments
 (0)