Update README.md

This commit is contained in:
Rody Davis 2019-02-19 10:46:09 -05:00 committed by GitHub
parent 8e968a2123
commit 193d21a352
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,69 +1,3 @@
# flutter_sms
![alt-text-1](https://github.com/AppleEducate/flutter_sms/blob/master/screenshots/ios_blank.PNG)
## Description
Flutter Plugin for sending SMS and MMS on Android and iOS. If you send to more than one person it will send as MMS. On the iOS if the number is an iPhone and iMessage is enabled it will send as an iMessage.
## How To Use
You can send multiple ways:
1. Message and No People
2. People and No Message
3. Message and People
This will prefil the correct fields.
## Setup
### Android
Add this to your AndroidManifest.xml
``` xml
<uses-permission android:name="android.permission.SEND_SMS"/>
```
### iOS
Good to go!
## Example
Make sure to Install and Import the Package.
``` dart
import 'package:flutter_sms/flutter_sms.dart';
```
Create a function for sending messages.
``` dart
void _sendSMS(String message, List<String> recipents) async {
String _result = await FlutterSms
.sendSMS(message: message, recipients: recipents)
.catchError((onError) {
print(onError);
});
print(_result);
}
```
You can quickly send the message with this function.
``` dart
String message = "This is a test message!";
List<String> recipents = ["1234567890", "5556787676"];
_sendSMS(message, recipents);
```
## Screenshots
iOS SMS | Android MMS
:-------------------------:|:-------------------------:
![alt-text-1](https://github.com/AppleEducate/flutter_sms/blob/master/screenshots/ios_sms.PNG) | ![alt-text-2](https://github.com/AppleEducate/flutter_sms/blob/master/screenshots/android_mms.png)
You can find other [screenshots here](https://github.com/AppleEducate/flutter_sms/tree/master/screenshots).
<h3 align="center">The <i>flutter_sms<i> plugin was moved to <a href='https://github.com/AppleEducate/plugins'>plugins/packages/flutter_sms</a></h3>