Skip to content

Commit

Permalink
started to write the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
franzose committed Jun 8, 2016
1 parent b13afff commit ef12dc6
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
15 changes: 11 additions & 4 deletions config/laravel-smpp.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@
|--------------------------------------------------------------------------
|
| 1. "sender" is the SMS message sender, either phone number or something like ABCDEF.
| 2. "source_ton"
| 3. "source_npi"
| 4. "destination_ton"
| 5. "destination_npi"
| 2. "source_ton" is the sender's type of number
| 3. "source_npi" is the sender's numbering plan identification
| 4. "destination_ton" is the receiver's type of number
| 5. "destination_npi" is the receiver's numbering plan identification
|
| Usually SMPP providers provide these settings to their clients.
| Please refer to official SMPP protocol specification v3.4 to learn more about TON and NPI settings.
|
*/

Expand All @@ -27,6 +30,10 @@
|--------------------------------------------------------------------------
| Custom SMPP provider settings
|--------------------------------------------------------------------------
|
| Most of the time, settings shown under the "example" key are be provided by your SMPP provider.
| So if you don't have any of these settings, please contact your SMPP provider.
|
*/

'default' => env('SMPP_DEFAULT_PROVIDER'),
Expand Down
16 changes: 16 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Laravel SMPP
This package is a tiny wrapper for the [onlinecity/php-smpp](https://github.com/onlinecity/php-smpp) library.
It provides a basic SMPP interface and implementation for the Laravel 5.2 framework.

## Installation
You can install Laravel SMPP using Composer command:
```bash
$ composer require franzose/laravel-smpp
```

Then you need to add `LaravelSmpp\LaravelSmppServiceProvider::class` to your providers array in the `config/app.php`
and copy default configuration by invoking `$ php artisan vendor:publish` command.

## Usage

To be continued...

0 comments on commit ef12dc6

Please sign in to comment.