Skip to content

Commit

Permalink
Formatting readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MUTYALA ANANTHA LAKSHMAJI authored Apr 11, 2017
1 parent 51a70d8 commit 867a28e
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Laravel - plivo
[docs on web](http://lakshmajim.github.io/plivo/)
>##WHAT IT IS?
>## WHAT IT IS?
- This package is used to send sms to any mobile number.
- This uses [Plivo!](https://www.plivo.com/) API.
- It requires *AuthId* and *AuthToken*, they can be generated by registrting @at [Plivo](https://manage.plivo.com/dashboard/)
- It requires *AuthId* and *AuthToken*, they can be generated by registering @at [Plivo](https://manage.plivo.com/dashboard/)
- after registrion click on Dashboard ,there you will be able to see authid and authtoken.
- sample snapshot:
![Image of plivo dashboard](https://raw.githubusercontent.com/lakshmajim/images/master/plivo.png)
Expand All @@ -25,15 +25,15 @@
4.2 | 1.1.0


>##INSTALLATION
>## INSTALLATION
To install this package you will need:
- Laravel 4 or 5 (see compatibility table)
- PHP

Install via composer ( you can install this package issuing the following command from the terminal )
``` composer require lakshmajim/plivo ```

>##Laravel INTEGRATION
>## Laravel INTEGRATION
Once this has finished, you will need to add the service provider to the **providers** array in your app.php config as follows:
```php
Expand All @@ -44,15 +44,17 @@ Next, also in the app.php config file, under the **aliases** array, you are requ
'Plivo' => Lakshmajim\Plivo\Facade\Plivo::class,
```
Finally, you will want to publish the config using the following command:
``` php artisan vendor:publish ```
```php
php artisan vendor:publish
```


In the plivo.php configuration file we need to enter the Plivo API key and ID

> **Don't forget to set a auth id and auth secret keys in the config file!**, you can get them at Plivo dashboard.

>##SENDING SMS
>## SENDING SMS
```php
<?php
Expand All @@ -67,7 +69,7 @@ $params = array(

Plivo::sendSMS($params);
```
>##Sent SMS history
>## Sent SMS history
```php
<?php
Expand All @@ -87,7 +89,7 @@ $params = array(
$list_some_messages = Plivo::allMessages($params);
```

>##Get Message data
>## Get Message data
```php
<?php
Expand All @@ -107,7 +109,7 @@ $params = array(
$list_some_messages = Plivo::allMessages($params);
```

>##MISCELLANEOUS
>## MISCELLANEOUS
```php
<?php
Expand All @@ -123,7 +125,7 @@ $list_some_messages = Plivo::allMessages($params);
```


>##EXAMPLE CODE FOR Laravel
>## EXAMPLE CODE FOR Laravel
```php

Expand Down Expand Up @@ -152,9 +154,9 @@ class Controller extends BaseController

```

>##LICENSE
>## LICENSE
[MIT](https://opensource.org/licenses/MIT)

>##Todo
- Need to add voice support
>## Todo
- Need to add voice support

0 comments on commit 867a28e

Please sign in to comment.