Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imrostom authored Mar 6, 2021
1 parent 4306935 commit 3f38241
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Very short description of the package
# MUTHOFUN SMS GATEWAY

[![Latest Version on Packagist](https://img.shields.io/packagist/v/imrostom/muthofun.svg?style=flat-square)](https://packagist.org/packages/imrostom/muthofun)
[![Build Status](https://img.shields.io/travis/imrostom/muthofun/master.svg?style=flat-square)](https://travis-ci.org/imrostom/muthofun)
[![Quality Score](https://img.shields.io/scrutinizer/g/imrostom/muthofun.svg?style=flat-square)](https://scrutinizer-ci.com/g/imrostom/muthofun)
[![Total Downloads](https://img.shields.io/packagist/dt/imrostom/muthofun.svg?style=flat-square)](https://packagist.org/packages/imrostom/muthofun)

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.
Muthofun SMS GATEWAY is a LARAVEL client for MUTHOFUN SMS Gateway API

## Installation

Expand All @@ -17,10 +17,38 @@ composer require imrostom/muthofun

## Usage

You this namespace in your controllers:
``` php
// Usage description here
use Imrostom\Muthofun\Facade\Muthofun;

```

## Configuration

Publish muthofun config file and configure your mutofun information.
``` php
return [
'username' => 'imrostom',
'password' => '123456',
'unicode' => 1, // 1 or 0
'database' => true,
'demo' => true,
'version' => '1.0',
];

```

To send message single user
``` php
$response = Muthofun::messages(['mobile'=> '+0145465', 'message'=> 'a demo message'])->send();

```

To send message mutiple user
``` php
$response = Muthofun::messages([['mobile'=> '+0145465', 'message'=> 'a demo message'], ['mobile'=> '+0145465', 'message'=> 'a demo message']])->send();

```
### Testing

``` bash
Expand All @@ -47,10 +75,3 @@ If you discover any security related issues, please email [email protected]
## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Laravel Package Boilerplate

This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).
=======
# muthofun
A muthofun package

0 comments on commit 3f38241

Please sign in to comment.