Very short description of the package
, (*1)
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors., (*2)
Installation
You can install the package via composer:, (*3)
composer require strebl/inetworx-client
Laravel
If you are using Laravel, you can register the service provider:, (*4)
'providers' => [
// ...
Strebl\Inetworx\InetworxServiceProvider::class,
];
To publish the config file to config/inetworx.php
run (optional):, (*5)
php artisan vendor:publish --provider="Strebl\Inetworx\InetworxServiceProvider"
If you are using Laravel, you can register the service provider:, (*6)
'aliases' => [
// ...
'Inetworx' => Strebl\Inetworx\InetworxFacade::class,
];
Set the environment variables with the correct values:, (*7)
INETWORX_AUTH_HEADER_USERNAME=null
INETWORX_AUTH_HEADER_PASSWORD=null
INETWORX_API_USERNAME=null
INETWORX_API_PASSWORD=null
Usage
With Laravel
``` php
$skeleton = app(Strebl\Inetworx::class);
$sms->send($phoneNumber, 'Hello, Manuel!', $senderPhoneNumber);, (*8)
Or you can use the Facade:
``` php
\Inetworx::send($phoneNumber, 'Hello, Manuel!', $senderPhoneNumber);
Without Laravel
``` php
$sms = new Strebl\Inetworx(
$authHeaderUsername,
$authHeaderPassword,
$apiUsername,
$apiPassword,
);
$sms->send($phoneNumber, 'Hello, Manuel!', $senderPhoneNumber);, (*9)
### Send a SMS
``` php
$sms->send($to, $message, $from);
Get the remaining SMS credits
``` php
$sms->credit();, (*10)
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
Contributing
Please see CONTRIBUTING for details., (*11)
Security
If you discover any security related issues, please email manuel@strebel.xyz instead of using the issue tracker., (*12)
Credits
License
The MIT License (MIT). Please see License File for more information., (*13)