Skip to content

Commit 466bd9d

Browse files
feat: add roadmap section to Readme
1 parent fe40b2e commit 466bd9d

File tree

1 file changed

+52
-25
lines changed

1 file changed

+52
-25
lines changed

README.md

Lines changed: 52 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,55 @@
11
# react-native-twilio-programmable-voice
22

3-
This is a React-Native wrapper for [Twilio Programmable Voice SDK](https://www.twilio.com/voice) which lets you make and receive calls from your React-Native App. This module is not affiliated with nor officially maintained by Twilio, and it is maintained by open source contributors.
3+
This is a react-native wrapper around [Twilio Programmable Voice SDK](https://www.twilio.com/voice), which allows your react-native app to make and receive calls.
44

5-
## Twilio Programmable Voice SDK
5+
This module is not affiliated with nor officially maintained by Twilio. It is maintained by open source contributors working during their nights and weekends.
66

7-
- Android 4.5.0 (bundled within the module)
8-
- iOS 5.1.0 (specified by the app's own podfile)
7+
Tested with:
98

10-
## Breaking changes in v4.0.0
9+
- react-native 0.62.2
10+
- Android 11
11+
- iOS 14
12+
13+
## Roadmap
14+
15+
### Project 1
16+
17+
The most updated branch is [feat/twilio-android-sdk-5](https://github.com/hoxfon/react-native-twilio-programmable-voice/tree/feat/twilio-android-sdk-5) which is aligned with:
18+
19+
- Android 5.0.2
20+
- iOS 5.2.0
21+
22+
It contains breaking changes from `react-native-twilio-programmable-voice` v4, and it will be released as v5.
23+
24+
You can install it with:
25+
```bash
26+
yarn add https://github.com/hoxfon/react-native-twilio-programmable-voice#feat/twilio-android-sdk-5
27+
```
28+
29+
I am currently updating the library to catchup with all changes published on the latest Android and iOS Twilio Voice SDK:
30+
31+
[iOS changelog](https://www.twilio.com/docs/voice/voip-sdk/ios/changelog)
32+
[Android changelog](https://www.twilio.com/docs/voice/voip-sdk/android/3x-changelog)
33+
34+
My plan is to use the following links as a reference, and follow Twilio commit by commit.
35+
36+
- https://github.com/twilio/voice-quickstart-android
37+
- https://github.com/twilio/voice-quickstart-ios
38+
39+
_If you want to contribute please consider helping on this project._
40+
41+
### Project 2
42+
43+
Allow Android to use the built in Android telephony service to make and receive calls.
44+
45+
## Stable release
46+
47+
### Twilio Programmable Voice SDK
48+
49+
- Android 4.5.0
50+
- iOS 5.2.0
51+
52+
### Breaking changes in v4.0.0
1153

1254
The module implements [react-native autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) as many other native libraries > react-native 0.60.0, therefore it doesn't need to be linked manually.
1355

@@ -53,14 +95,14 @@ iOS application can now receive the following events, that in v3 where only disp
5395
- connectionIsReconnecting
5496
- connectionDidReconnect
5597

56-
## Breaking changes in v3.0.0
98+
### Breaking changes in v3.0.0
5799

58100
- initWitToken returns an object with a property `initialized` instead of `initilized`
59101
- iOS event `connectionDidConnect` returns the same properties as Android
60102
move property `to` => `call_to`
61103
move property `from` => `call_from`
62104

63-
## Installation
105+
### Installation
64106

65107
Before starting, we recommend you get familiar with [Twilio Programmable Voice SDK](https://www.twilio.com/docs/api/voice-sdk).
66108
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.
@@ -92,23 +134,8 @@ After you have linked the library with `react-native link react-native-twilio-pr
92134
check that `libRNTwilioVoice.a` is present under YOUR_TARGET > Build Phases > Link Binaries With Libraries. If it is not present you can add it using the + sign at the bottom of that list.
93135
</details>
94136

95-
Edit your `Podfile` to include TwilioVoice framework
96-
97-
```ruby
98-
source 'https://github.com/cocoapods/specs'
99-
100-
# min version for TwilioVoice to work
101-
platform :ios, '10.0'
102-
103-
target <YOUR_TARGET> do
104-
...
105-
pod 'TwilioVoice', '~> 5.2.0'
106-
...
107-
end
108-
```
109-
110137
```bash
111-
cd ios/ && pod install
138+
cd ios && pod install
112139
```
113140

114141
#### CallKit
@@ -130,7 +157,7 @@ To pass caller's name to CallKit via Voip push notification add custom parameter
130157

131158
Twilio Programmable Voice for iOS utilizes Apple's VoIP Services and VoIP "Push Notifications" instead of FCM. You will need a VoIP Service Certificate from Apple to receive calls. Follow [the official Twilio instructions](https://github.com/twilio/voice-quickstart-ios#7-create-voip-service-certificate) to complete this step.
132159

133-
## Android Installation
160+
### Android Installation
134161

135162
Setup FCM
136163

@@ -144,7 +171,7 @@ buildscript {
144171
dependencies {
145172
// override the google-service version if needed
146173
// https://developers.google.com/android/guides/google-services-plugin
147-
classpath 'com.google.gms:google-services:4.3.3'
174+
classpath 'com.google.gms:google-services:4.3.4'
148175
}
149176
}
150177

0 commit comments

Comments
 (0)