diff --git a/README.md b/README.md index a2623f41..535472d3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # react-native-twilio-programmable-voice -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. + +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. # Twilio Programmable Voice SDK @@ -47,7 +48,9 @@ ReactNative success is directly linked to its module ecosystem. One way to make ## Installation Before starting, we recommend you get familiar with [Twilio Programmable Voice SDK](https://www.twilio.com/docs/api/voice-sdk). -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. +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). + +### Manual Linking ``` @@ -130,8 +133,9 @@ buildscript { dependencies { ... + // on React Native 0.60+, this module can be auto-linked and doesn't need a manual entry here - compile project(':react-native-twilio-programmable-voice') + implementation project(':react-native-twilio-programmable-voice') } // this plugin looks for google-services.json in your project @@ -158,22 +162,12 @@ In your `AndroidManifest.xml` - - - - - - - - ..... ``` -In `android/settings.gradle` +In `android/settings.gradle` (not necessary if auto-linking on RN 0.60+) ```gradle ... @@ -182,7 +176,7 @@ include ':react-native-twilio-programmable-voice' project(':react-native-twilio-programmable-voice').projectDir = file('../node_modules/react-native-twilio-programmable-voice/android') ``` -Register module (in `MainApplication.java`) +Register module (in `MainApplication.java`) (not necessary if auto-linking on RN 0.60+ unless you want to control microphone permission) ```java import com.hoxfon.react.RNTwilioVoice.TwilioVoicePackage; // <--- Import Package