Skip to content

Commit 86177dc

Browse files
committed
doc: update README
1 parent 52ad51b commit 86177dc

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Any and all [Feature Requests](https://github.com/cybex-dev/twilio_voice/issues/
2020

2121
## Features
2222

23-
- Receive and place calls from iOS devices, uses Callkit to receive calls.
24-
- Receive and place calls from Android devices, uses ~~custom UI~~ native call screen to receive calls (via a `ConnectionService` impl).
23+
- Receive and place calls from iOS devices, uses Callkit to receive calls (Twilio Voice SDK [v6.13.0](https://www.twilio.com/docs/voice/sdks/ios/changelog#6130)).
24+
- Receive and place calls from Android devices, uses ~~custom UI~~ native call screen to receive calls (via a `ConnectionService` impl) (Twilio Voice SDK [v6.9.0](https://www.twilio.com/docs/voice/sdks/android/3x-changelog#690)).
2525
- Receive and place calls from Web (FCM push notification integration not yet supported by Twilio Voice Web, see [here](https://github.com/twilio/twilio-voice.js/pull/159#issuecomment-1551553299) for discussion)
2626
- Receive and place calls from MacOS devices, uses custom UI to receive calls (in future & macOS
2727
13.0+, we'll be using CallKit).
2828
- Interpret TwiML parameters to populate UI, see below [Interpreting Parameters](#interpreting-parameters)
2929

30-
## Feature addition schedule:
30+
### Feature addition schedule:
3131

3232
- Audio device selection support (select input/output audio devices, on-hold)
3333
- Update plugin to Flutter federated packages (step 1 of 2 with Web support merge)
@@ -54,7 +54,17 @@ This limits macOS to not support remote push notifications `.voip` and `.apns` a
5454
not support this. Instead, it uses a web socket connection to listen for incoming calls, arguably
5555
more efficient vs time but forces the app to be open at all times to receive incoming calls.
5656

57-
### Setup
57+
## Getting Started
58+
59+
First, add the package to your `pubspec.yaml` file:
60+
61+
```yaml
62+
dependencies:
63+
...
64+
twilio_voice: ^0.2.0+1
65+
```
66+
67+
Then run `flutter pub get` in your terminal.
5868

5969
Please follow Twilio's quickstart setup for each platform, you don't need to write the native code
6070
but it will help you understand the basic functionality of setting up your server, registering your

0 commit comments

Comments
 (0)