Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
abreeden committed Sep 9, 2014
1 parent 8365fb3 commit 4fc98bc
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## TransmitSMS-API for Laravel

Provides an implementation for the TransmitSMS-API as used by BurstSMS (burstsms.com.au)

Original class was developed by BurstSMS and this is just a package of their class and is not an official module it is something I packaged up to make it easier for using their system.

## Documentation

To send a message you will require an account with a provider using the TransmitSMS API such as BurstSMS. Use the following syntax to initialise and send a message in Laravel 4.

$sms = new \Abreeden\TransmitsmsApi\TransmitsmsApi("API_KEY",'API_Secret');
$result=$sms->sendSms("Message goes here","Destination Number","From");

0 comments on commit 4fc98bc

Please sign in to comment.