updated readme

This commit is contained in:
Rody Davis 2018-08-16 09:58:07 -04:00
parent 25211934b2
commit bed77c2d94
12 changed files with 59 additions and 6 deletions

View File

@ -1,10 +1,64 @@
# flutter_sms
A Flutter plugin for Sending SMS on Android and iOS.
![alt text](repo/blob/master/screenshots/ios_blank.PNG)
## Getting Started
## Description
For help getting started with Flutter, view our online
[documentation](https://flutter.io/).
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.
For help on editing plugin code, view the [documentation](https://flutter.io/developing-packages/#edit-plugin-package).
## 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
String _message = "";
void _sendSMS(String message, List<String> recipents) async {
String _result =
await FlutterSms.sendSMS(message: message, recipients: recipents);
setState(() => _message = _result);
}
```
You can quickly send the message with this function.
``` dart
_sendSMS("Here is a test Message", ["5555543454", "78467477788"])
```
## Screenshots
![alt text](repo/blob/master/screenshots/ios_sms.PNG)
![alt text](repo/blob/master/screenshots/android_mms.png)
You can find other [screenshots here](repo/blob/screenshots).

View File

@ -1,7 +1,6 @@
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:flutter_sms/flutter_sms.dart';
void main() => runApp(new MyApp());

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

BIN
screenshots/android_mms.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

BIN
screenshots/android_sms.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

BIN
screenshots/ios_blank.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

BIN
screenshots/ios_mms.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

BIN
screenshots/ios_single.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

BIN
screenshots/ios_sms.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB