Skip to content

Commit 5bf5de4

Browse files
committed
Basic readme
1 parent 178c82a commit 5bf5de4

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
11
[![Build Status](https://travis-ci.org/scaytrase/websms-php.svg?branch=master)](https://travis-ci.org/scaytrase/websms-php)
2-
32
[![Latest Stable Version](https://poser.pugx.org/scaytrase/websms-php/v/stable)](https://packagist.org/packages/scaytrase/websms-php)
43
[![Latest Unstable Version](https://poser.pugx.org/scaytrase/websms-php/v/unstable)](https://packagist.org/packages/scaytrase/websms-php)
54
[![Total Downloads](https://poser.pugx.org/scaytrase/websms-php/downloads)](https://packagist.org/packages/scaytrase/websms-php)
6-
75
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/39774f8b-ef2b-4b6c-a675-1b4803d7f538/mini.png)](https://insight.sensiolabs.com/projects/39774f8b-ef2b-4b6c-a675-1b4803d7f538)
86

9-
107
# WebSMS PHP Library
118

9+
A tiny library for sending SMS via [WebSMS](http://websms.ru/) gateway.
10+
This gateway requires you to be registered in order to send SMS.
11+
1212
## Installation
1313

14+
The best way to handle dependencies is to use Composer
15+
16+
### Composer
17+
18+
```bash
19+
composer require "scaytrase/websms-php"
20+
```
21+
1422
## Usage
23+
24+
```php
25+
$driver = new JsonDriver();
26+
$connection = new Connection($driver, 'username', 'secret');
27+
28+
// Optionally check that connection runs well
29+
// $connection->verify();
30+
// echo $connection->getBalance();
31+
32+
$message = new Message('+79991234567', 'test message');
33+
$connection->send($message);
34+
```

0 commit comments

Comments
 (0)