Update of Readme

Author: demogorgorn

README.md

@@ -1,4 +1,4 @@
-AjaxSubmitButton for Yii 2
+# AjaxSubmitButton for Yii 2
 =====================================
 
 [![Latest Stable Version](https://poser.pugx.org/demogorgorn/yii2-ajax-submit-button/v/stable)](https://packagist.org/packages/demogorgorn/yii2-ajax-submit-button)
@@ -7,9 +7,11 @@ AjaxSubmitButton for Yii 2
 [![Monthly Downloads](https://poser.pugx.org/demogorgorn/yii2-ajax-submit-button/d/monthly)](https://packagist.org/packages/demogorgorn/yii2-ajax-submit-button)
 
 
-This is the AjaxSubmitButton widget that renders an ajax button which is very similar to ajaxSubmitButton from Yii1 for Yii 2. 
+This is the powerful AjaxSubmitButton widget that renders an ajax button which is very similar to ajaxSubmitButton from Yii1 for Yii 2, but has many useful functions.
 
-Example of usage of the widget with form and other custom widget (in this case Select2 widget).
+### Basic Example
+
+Example of usage of the widget with a custom widget (in this case Select2 widget).
 
 The view:
 ```php
@@ -33,7 +35,6 @@ use demogorgorn\ajax\AjaxSubmitButton;
     'ajaxOptions' => [
         'type'=>'POST',
         'url'=>'country/getinfo',
-        /*'cache' => false,*/
         'success' => new \yii\web\JsExpression('function(html){
             $("#output").html(html);
             }'),
@@ -63,7 +64,86 @@ public function actionGetinfo()
 }
 ```
 
-Installation
+### Example of usage with ActiveForm and client validation
+
+The view:
+```php
+    $form = ActiveForm::begin([
+               'id' => 'add-form',
+               'options' => ['class' => 'form-inline'],
+            ]);
+
+    ...
+
+    AjaxSubmitButton::begin([
+        'label' => 'Add',
+        'useWithActiveForm' => 'add-form',
+        'ajaxOptions' => [
+            'type' => 'POST',
+            'success' => new \yii\web\JsExpression("function(data) {
+                if (data.status == true) 
+                {
+                    closeTopbar();
+                }                                            
+            }"),
+        ],
+        'options' => ['class' => 'btn btn-primary', 'type' => 'submit', 'id' =>'add-button'],
+    ]);
+    AjaxSubmitButton::end();
+    
+    ActiveForm::end()
+```
+
+> As you can see it's quite easy to use the widget with ActiveForm - enough to set the ActiveForm's id to the 'useWithActiveForm' variable. (In this case id is 'add-form', without '#' symbol!).
+
+
+### Client validation
+
+As I said before the widget can be used with ActiveForm and client validation enabled. If you wish to disable it, just set ActiveForm's 'enableClientValidation' to false.
+
+```php
+    $form = ActiveForm::begin([
+                'id' => 'filters-form',
+                'enableClientValidation' => false
+            ]);
+```
+
+### Preloader use
+
+It's possible to use the widget with your own custom preloader.
+
+```php
+<?php AjaxSubmitButton::begin([
+    'label' => 'Check',
+    'ajaxOptions' => [
+        'type'=>'POST',
+        'url'=>'country/getinfo',
+        'beforeSend' => new \yii\web\JsExpression('function(html){
+            ... show preloader...
+            }'),
+        'success' => new \yii\web\JsExpression('function(html){
+            ... hide preloader ...
+            }'),
+    ],
+    'options' => ['class' => 'customclass', 'type' => 'submit'],
+    ]);
+    AjaxSubmitButton::end();
+?>
+```
+
+### Widget's options
+
+Variable | Description
+------------ | -------------
+ajaxOptions | array of js ajax options.
+options | array of the HTML attributes and other options of the widget's container tag
+tagName | (string) the tag to use to render the button (by default is 'button'. You can specify, for example, 'a' tag).
+label | (string) button's label
+encodeLabel | (boolean) whether the label should be HTML-encoded.
+clickedButtonVarName | (string) js object name. It is unused when useWithActiveForm is enabled.
+useWithActiveForm | (boolean) whether the button should not be used with ActiveForm. (string) the id of ActiveForm to use the button with.
+
+## Installation
 ------------
 
 The preferred way to install this extension is through [composer](http://getcomposer.org/download/).