Merge pull request #2 from nasrulhazim/master

Added Validator View

Author: Shiburaj Pappu

README.md

@@ -1,75 +1,87 @@
 ## SweetAlert 2
-Laravel 5 Package for <a href="https://github.com/sweetalert2/sweetalert2/">SweetAlert 2</a>. Use this package to easily show sweetalert2 prompts in your laravel app.
 
-<strong>Installation</strong>
+Laravel 5 Package for [SweetAlert 2](https://github.com/sweetalert2/sweetalert2/). Use this package to easily show SweetAlert prompts in your Laravel application.
 
-<ol>
-  <li>Use composer to install the package<br>
-      <pre><code> composer require softon/sweetalert </code></pre>
-  </li>
-  <li>(Optional for Laravel 5.5) Add the service provider to the config/app.php file in Laravel<br>
-      <pre><code> Softon\SweetAlert\SweetAlertServiceProvider::class, </code></pre>
-      
-  </li>
-  <li>(Optional for Laravel 5.5) Add an alias for the Facade to the config/app.php file in Laravel<br>
-      <pre><code> 'SWAL' => Softon\SweetAlert\Facades\SWAL::class, </code></pre>
-      
-  </li>
-  <li>Publish the config & views by running <br>
-      <pre><code> php artisan vendor:publish </code></pre>
+### Installation
+
+1. Use composer to install the package
+
+```bash
+$ composer require softon/sweetalert
+```
+
+2. (Optional for Laravel 5.5) Add the service provider to the config/app.php file in Laravel
+
+```php    
+Softon\SweetAlert\SweetAlertServiceProvider::class,
+```
+
+3. (Optional for Laravel 5.5) Add an alias for the Facade to the config/app.php file in Laravel<br>
+
+```php   
+'SWAL' => Softon\SweetAlert\Facades\SWAL::class,
+```
       
-  </li>
-</ol>
+4. Publish the config & views by running <br>
 
-<strong>Config File:</strong>
+```bash
+$ php artisan vendor:publish
+```
 
-You can change the basic parameters of the package. Refer the <a href="https://github.com/sweetalert2/sweetalert2/">SweetAlert2</a> Docs for details.
+### View
 
-<strong>View Files:</strong>
+This package does have its own views to be included in your templates. But if you would like to tweak it or include your own you can use the views published in the `resources/views/vendor/sweetalert` directory. 
 
-This package does have its own views to be included in your templates. But if you would like to tweak it or include your own you can use the views published in the resources/views/vendor/sweetalert directory. This package also includes a SweetAlert2 CDN that you can include if you have not included the SweetAlert2 Javascript file from their website. The CDN view must be loaded first.
+This package also includes a SweetAlert2 CDN that you can include if you have not included the SweetAlert2 Javascript file from their website. The CDN view must be loaded first.
+
+For built in views, you can use this in your blade templates before the closing body tag
 
-For Inbuilt views use this in your blade templates before the closing body tag
 ```php
-@include('sweetalert::cdn')
+@include('sweetalert::cdn')         // Optional needed only if SweetAlert2 files are not inserted by the developer 
 @include('sweetalert::view')
-
+@include('sweetalert::validator')   // Optional needed only to show form validation errors automatically
 ```
 
 Or for the Published Views use this
+
 ```php
-@include('vendor.sweetalert.cdn')
+@include('vendor.sweetalert.cdn')   // Optional needed only if SweetAlert2 files are not inserted by the developer
 @include('vendor.sweetalert.view')
+@include('vendor.sweetalert.validator')   // Optional needed only to show form validation errors automatically
 ```
 
-#Usage
+### Configuration
+
+You can change the basic parameters of the package by referring to the [SweetAlert2](https://github.com/sweetalert2/sweetalert2/) documentations for more details.
+
+### Usage
 
 You may use the SWAL Facade or the swal helper function to call the methods.
 
-Showing a Message to User using the SWAL Facade:-
+Showing a Message to User using the SWAL Facade:
+
 ```php
 use Softon\SweetAlert\Facades\SWAL;  
 
-
-
 // Params: [Title,Text,Type,Options[]]
 SWAL::message('Good Job','You have successfully logged In!','info');  
 SWAL::message('Good Job','You have successfully logged In!','error');  
 SWAL::message('Good Job','You have successfully logged In!','success',['timer'=>2000]);
 
 // For All available options please refer the SweetAlert 2 Docs
-
  ```
 
-Showing a Message to User using the swal helper function:-
+Showing a Message to User using the swal helper function:
+
 ```php
+
+//Message Type Can be `warning`, `error`, `success`, `info` and `question`. Based on this there are some convinence function that can be used instead of the message method.:
 swal('Your Title','Text');
 swal()->message('Good Job','You have successfully logged In!','info');  
 swal()->message('Good Job','You have successfully logged In!','error');  
 swal()->message('Good Job','You have successfully logged In!','success',['timer'=>2000]);
  ```
 
-Message Type Can be 'warning', 'error', 'success', 'info' and 'question'. Based on this there are some convinence function that can be used instead of the message method.:-
 ```php
 // Params [Title, Text, Options]
 swal()->warning('Good Job','You have successfully logged In!',[]);
@@ -79,31 +91,36 @@ swal()->info('Good Job','You have successfully logged In!',[]);
 swal()->question('Good Job','You have successfully logged In!',[]);
 ```
 
-To show modal which will autoclose after few seconds:-
+To show modal which will autoclose after few seconds:
+
 ```php 
 swal()->autoclose(2000)->message('Good Job','You have successfully logged In!','info'); 
 swal()->autoclose(5000)->success('Good Job','You have successfully logged In!'); 
 ```
 
-To show a toast modal which will autoclose after few seconds:-
+To show a toast modal which will autoclose after few seconds:
+
 ```php 
 swal()->toast()->autoclose(2000)->message('Good Job','You have successfully logged In!','info'); 
 ```
 
-To change confirm button text:-
+To change confirm button text:
+
 ```php 
 swal()->button('Close Me')->message('Good Job','You have successfully logged In!','info'); 
 
 // Button Params [Button Text,Button Colour, SWAL Style Enable / Disable, Style Class for Buttons]
 swal()->button('Close Me','#efefef',false,'btn btn-primary')->info('Good Job','You have successfully logged In!'); 
 ```
 
-To change position of the modal:-
-```php 
+To change position of the modal:
+
 //  Possible Posions : 'top', 'top-left', 'top-right', 'center', 'center-left', 'center-right', 'bottom', 'bottom-left', or 'bottom-right'
 swal()->position('top')->message('Good Job','You have successfully logged In!','info'); 
 ```
 
+Possible Positions : `top`, `top-left`, `top-right`, `center`, `center-left`, `center-right`, `bottom`, `bottom-left`, or `bottom-right`
+
 You can chain any of these methods to combine the functionality:
 
 ```php 

src/Facades/SWAL.php

@@ -2,8 +2,10 @@
 
 use Illuminate\Support\Facades\Facade;
 
-class SWAL extends Facade {
-
-    protected static function getFacadeAccessor() { return 'softon.sweetalert'; }
-
-}
+class SWAL extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return 'softon.sweetalert';
+    }
+}