From 66ee58de00bf2d73cded3d10ca25c9b4cbb1dbba Mon Sep 17 00:00:00 2001
From: Gergely POLONKAI <polesz@w00d5t0ck.info>
Date: Sun, 7 Oct 2012 21:20:03 +0200
Subject: [PATCH] Created README.md

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d5517dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+SmsSenderBundle
+===============
+
+This bundle integrates with [gergelypolonkai/smssender](https://github.com/gergelypolonkai/smssender) to send SMS messages through
+[gergelypolonkai/smsgateway](https://github.com/gergelypolonkai/smsgateway).
+
+## Installation
+
+Simply add gergelypolonkai/smssender-bundle to your Symfony2 project's
+composer.json file, and run
+
+    php composer.phar update
+
+## Configuration
+
+Everything is configurable through the Symfony project's configuration files.
+In YML format, the possibilities are:
+
+    gergely_polonkai_sms_sender:
+
+        # This must be set, as it has no default value
+        sender_url: http://localhost/smsgateway
+
+        # The username/password to use to login to SmsGateway. No default values
+        # are available, either
+        username: gateway-user
+        password: gateway-password
+
+        # This defaults to true. You should set this to false if you use
+        # self-signed certificates
+        verify_ssl: true
+
+        # This is the default value. Currently SmsGateway requires this to be
+        # be set to application/json
+        content_type: application/json
+
+        # The content-encoding of the data you send to the server. This must be
+        # UTF-8 if you want to send an SMS with non-ascii characters.
+        content-encoding: utf-8
+
+        # This should be turned on only for debugging purposes. It makes CURL to
+        # log every traffic it makes with SmsGateway.
+        verbose_curl: false
+
+## Usage
+
+Everything is done via the gergely\_polonkai\_sms\_sender.sender service.
+
+    $sender = $container->get('gergely_polonkai_sms_sender.sender');
+    $sender->login();
+    $sender->send('+155523456789', 'Hello world!', array());
+    $sender->logout();