Update README, move the docs to the official website

README.md

@@ -1,6 +1,6 @@
 # BootstrapValidator
 
-A jQuery plugin to validate form fields. Use with [Bootstrap 3](http://getbootstrap.com)
+[http://bootstrapvalidator.com](http://bootstrapvalidator.com) - A jQuery plugin to validate form fields. Use with [Bootstrap 3](http://getbootstrap.com)
 
 ![Screenshot](screenshots/screenshot.png)
 
@@ -20,7 +20,7 @@ A jQuery plugin to validate form fields. Use with [Bootstrap 3](http://getbootst
 * [jQuery](http://jquery.com/)
 * [Bootstrap 3](http://getbootstrap.com/)
 
-## Demo
+## Live Demo
 
 You can see the live demo here:
 
@@ -30,524 +30,10 @@ You can see the live demo here:
 * [Enable/disable validators on the fly](https://rawgithub.com/nghuuphuoc/bootstrapvalidator/master/demo/enable.html)
 * [Use with a datetime picker plugin](https://rawgithub.com/nghuuphuoc/bootstrapvalidator/master/demo/date.html)
 
-## Install
+## Documentation
 
-You can download the [latest version](https://github.com/nghuuphuoc/bootstrapvalidator/releases) or use [bower](http://bower.io) to install BootstrapValidator:
-
-```bash
-$ bower install bootstrapValidator
-```
-
-## Usage
-
-The plugin has two versions:
-
-* The source one placed in ```src/js``` directory which is not compressed and doesn't include any validators.
-It is used in case you want to debug or develop new validator.
-* The compressed one placed in ```dist/js``` directory which includes all validators.
-It should be used in the production site.
-
-Since the __BootstrapValidator__ plugin requires jQuery and Bootstrap 3, you have to include the required CSS and JS files to your page:
-
-```html
-<link rel="stylesheet" href="/path/to/bootstrap/css/bootstrap.css"/>
-<link rel="stylesheet" href="/path/to/dist/js/bootstrapValidator.min.css"/>
-
-<script type="text/javascript" src="/path/to/jquery/jquery-1.10.2.min.js"></script>
-<script type="text/javascript" src="/path/to/bootstrap/js/bootstrap.min.js"></script>
-
-// Either use the compressed version (recommended in the production site)
-<script type="text/javascript" src="/path/to/dist/js/bootstrapValidator.min.js"></script>
-
-// Or use the original one with all validators included
-<script type="text/javascript" src="/path/to/dist/js/bootstrapValidator.js"></script>
-
-// Or use the plugin with required validators
-<script type="text/javascript" src="/path/to/src/js/bootstrapValidator.js"></script>
-<script type="text/javascript" src="/path/to/src/js/validator/...validator..."></script>
-```
-
-Call the plugin to validate the form as following:
-
-```javascript
-$(document).ready(function() {
-    $(<form Selector>).bootstrapValidator({
-        message: 'This value is not valid',
-        feedbackIcons: ...,
-        submitButtons: 'button[type="submit"]',
-        submitHandler: null,
-        live: 'enabled',
-        fields: ...
-    });
-});
-```
-
-```message```: The default error message for all fields. You can specify the error message for any fields
-
-```feedbackIcons```: Indicate valid/invalid/validating icons based on the field validity.
-
-This feature requires [Bootstrap v3.1.0 or later](http://getbootstrap.com/css/#forms-control-validation).
-Since Bootstrap doesn't provide any methods to know its version, this option cannot be on/off automatically.
-In other word, to use this feature you have to upgrade your Bootstrap to v3.1.0 or later.
-
-It supports [Glyphicons](http://getbootstrap.com/components/#glyphicons) (included in Bootstrap):
-
-```javascript
-feedbackIcons: {
-    valid: 'glyphicon glyphicon-ok',
-    invalid: 'glyphicon glyphicon-remove',
-    validating: 'glyphicon glyphicon-refresh'
-}
-```
-
-and [FontAwesome](http://fontawesome.io/icons) icons (don't forget to insert FontAwesome CSS in your ```head```):
-
-```javascript
-feedbackIcons: {
-    valid: 'fa fa-check',
-    invalid: 'fa fa-times',
-    validating: 'fa fa-refresh'
-}
-```
-
-By default, these icons are not set.
-
-```submitButtons```: The submit buttons selector. These buttons will be disabled when the form input are invalid
-
-```submitHandler```: Custom submit handler.
-
-```javascript
-submitHandler: function(validator, form, submitButton) {
-}
-```
-
-Parameter    | Description
--------------|------------
-validator    | The instance of BootstrapValidator
-form         | jQuery object representing the current form
-submitButton | jQuery object representing the submit button which is clicked
-
-This option is useful when you want to use Ajax to submit the form data:
-
-```javascript
-submitHandler: function(validator, form, submitButton) {
-    // Use Ajax to submit form data
-    $.post(form.attr('action'), form.serialize(), function(result) {
-        // ... process the result ...
-    }, 'json');
-}
-```
-
-By default, ```submitHandler``` is ```null```.
-
-```live```: Live validating. Can be one of 3 values:
-
-- ```enabled```: The plugin validates fields as soon as they are changed
-- ```disabled```: Disable the live validating. The error messages are only shown after the form is submitted
-- ```submitted```: The live validating is enabled after the form is submitted
-
-```fields```: The fields which need to be validated
-
-```javascript
-fields: {
-    ...
-    // The field name
-    // It is value of the name attribute
-    <fieldName>: {
-        message: ...,       // The default error message for this field
-        enabled: true,      // Can be true of false
-
-        // Array of validators
-        validators: {
-            ...
-            <validatorName>: <validatorOptions>
-            ...
-        }
-    }
-    ...
-}
-```
-
-The ```<validatorName>``` can be the name of the built-in validator which are described in the [Validators](#validators) section
-
-## Validators
-
-Below is the list of built-in validators sorted in alphabetical order:
-
-Validator name                          | Description
-----------------------------------------|------------
-[between](#between-validator)           | Check if the input value is between (strictly or not) two given numbers
-[callback](#callback-validator)         | Return the validity from a callback method
-[choice](#choice-validator)             | Check if the number of checked boxes are less or more than a given number
-creditCard                              | Validate a credit card number
-[date](#date-validator)                 | Validate date
-[different](#different-validator)       | Return true if the input value is different with given field's value
-digits                                  | Return true if the value contains only digits
-emailAddress                            | Validate an email address
-[greaterThan](#greaterthan-validator)   | Return true if the value is greater than or equals to given number
-hexColor                                | Validate a hex color
-[identical](#identical-validator)       | Check if the value is the same as one of particular field
-[lessThan](#lessthan-validator)         | Return true if the value is less than or equals to given number
-notEmpty                                | Check if the value is empty
-[regexp](#regexp-validator)             | Check if the value matches given Javascript regular expression
-[remote](#remote-validator)             | Perform remote checking via Ajax request
-[stringLength](#stringlength-validator) | Validate the length of a string
-uri                                     | Validate an URL address
-[zipCode](#zipcode-validator)           | Validate a zip code
-
-The validator options are described in the following section:
-
-(**The options marked with * are required**)
-
-### between validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-min (*)     | n/a     | The lower value in the range
-max (*)     | n/a     | The upper value in the range
-inclusive   | true    | Can be ```true``` or ```false```. If ```true```, the input value must be in the range strictly
-
-### callback validator
-
-Option name  | Default | Description
--------------|---------|------------
-message      | n/a     | The error message
-callback (*) | n/a     | The callback method
-
-The callback method must follow the format below:
-
-```javascript
-function(fieldValue, validator) {
-    // fieldValue is the value of field
-    // validator is instance of BootstrapValidator
-
-    // Check the field validity
-    // return true or false
-}
-```
-
-### choice validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-min         | n/a     | The minimum number of check boxes required to be checked
-max         | n/a     | The maximum number of check boxes required to be checked. At least one of ```min``` and ```max``` is required
-
-### date validator
-
-Option name | Default           | Description
-------------|-------------------|------------
-message     | n/a               | The error message
-format (*)  | ```MM/DD/YYYY```  | The date format
-
-The ```format``` can be one of the following values:
-
-* YYYY/DD/MM, YYYY/DD/MM h:m A
-* YYYY/MM/DD, YYYY/MM/DD h:m A
-* YYYY-DD-MM, YYYY-DD-MM h:m A
-* YYYY-MM-DD, YYYY-MM-DD h:m A
-* MM/DD/YYYY, MM/DD/YYYY h:m A
-* DD/MM/YYYY, DD/MM/YYYY h:m A
-* MM-DD-YYYY, MM-DD-YYYY h:m A
-* DD-MM-YYYY, DD-MM-YYYY h:m A
-
-> If you want to use other format, you can use the ```callback``` validator and [momentjs](http://momentjs.com) to parse/validate the input.
-
-Format | Description
--------|------------
-MM     | Month number (1 - 12)
-DD     | Day of month
-YYYY   | 4 digit year
-h      | 12 hour time
-m      | Minutes
-A      | AM/PM
-
-### different validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-field (*)   | n/a     | The name of field that will be used to compare with current one
-
-### greaterThan validator
-
-| Option name | Default | Description
-|-------------|---------|------------
-| message     | n/a     | The error message
-| value (*)   | n/a     | The number to make a comparison to
-| inclusive   | false   | Can be ```true``` or ```false```
-|             |         | If ```true```, the input value must be greater than the comparison one
-|             |         | If ```false```, the input value must be greater than or equal to the comparison one
-
-### identical validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-field (*)   | n/a     | The name of field that will be used to compare with current one
-
-### lessThan validator
-
-| Option name | Default | Description
-| ------------|---------|------------
-| message     | n/a     | The error message
-| value (*)   | n/a     | The number to make a comparison to
-| inclusive   | false   | Can be ```true``` or ```false```
-|             |         | If ```true```, the input value must be less than the comparison one
-|             |         | If ```false```, the input value must be less than or equal to the comparison one
-
-### regexp validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-regexp (*)  | n/a     | The Javascript regular expression
-
-### remote validator
-
-Option name | Default                        | Description
-------------|--------------------------------|------------
-message     | n/a                            | The error message
-url (*)     | n/a                            | The remote URL that responses an encoded JSON of array containing the ```valid``` key
-data        | ```{ fieldName: fieldValue}``` | The data sent to remote URL
-
-It also supports dynamic data which is returned by a function:
-
-```javascript
-remote: {
-    url: 'remote.php',
-    data: function(validator) {
-        // validator is the plugin instance
-
-        // Returns an object which is used to send to remote URL
-        // For example, the sample code below posts the username to remote URL:
-        //  return {
-        //      username: validator.getFieldElements('username').val()
-        //  };
-    }
-}
-```
-
-### stringLength validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-min         | n/a     | The minimum length
-max         | n/a     | The maximum length. One of ```min```, ```max``` options is required
-
-### zipCode validator
-
-Option name | Default | Description
-------------|---------|------------
-message     | n/a     | The error message
-country     | US      | A ISO 3166 country code. Currently it supports the following countries: US (United State), DK (Denmark), SE (Sweden)
-
-## API
-
-### ```validate```
-
-```validate()```: Validate form manually. It is useful when you want to validate form by clicking a button or a link instead of a submit buttons.
-
-```javascript
-$(form).bootstrapValidator(options).bootstrapValidator('validate');
-
-// or
-$(form).bootstrapValidator(options);
-$(form).data('bootstrapValidator').validate();
-```
-
-### ```isValid```
-
-```isValid()```: Returns ```true``` if all form fields are valid. Otherwise, returns ```false```.
-
-Ensure that the ```validate``` method is already called after calling this one.
-
-### ```updateStatus```
-
-```updateStatus(field, status, validatorName)```: Update validator result for given field
-
-Parameter     | Description
---------------|------------
-field         | The field name or field element
-status        | Can be ```NOT_VALIDATED```, ```VALIDATING```, ```INVALID``` or ```VALID```
-validatorName | The validator name. If ```null```, the method updates validity result for all validators
-
-This method is useful when you want to use BootstrapValidator with other plugins such as [Date Picker](http://eternicode.github.io/bootstrap-datepicker/),
-[Datetime Picker](http://eonasdan.github.io/bootstrap-datetimepicker/), [Select2](http://ivaynberg.github.io/select2/), etc.
-
-By default, the plugin doesn't re-validate a field once it is already validated and marked as a valid one. When using with other plugins,
-the field value is changed and therefore need to be re-validated.
-
-The following example describes how to re-validate a field which uses with [Datetime Picker](http://eonasdan.github.io/bootstrap-datetimepicker/):
-
-_The form markup_:
-
-```html
-<form id="defaultForm" method="post" class="form-horizontal">
-    ...
-    <div class="form-group">
-        <label class="col-lg-3 control-label"><a href="http://eonasdan.github.io/bootstrap-datetimepicker/">DateTime Picker</a></label>
-        <div class="col-lg-5">
-            <div class="input-group date" id="datetimePicker">
-                <input type="text" class="form-control" name="datetimePicker" />
-                <span class="input-group-addon"><span class="glyphicon glyphicon-calendar"></span></span>
-            </div>
-        </div>
-    </div>
-    ...
-</form>
-```
-
-_Javascript_:
-
-```javascript
-<script type="text/javascript">
-$(document).ready(function() {
-    $('#datetimePicker').datetimepicker();
-
-    $('#defaultForm').bootstrapValidator({
-        fields: {
-            ...
-            datetimePicker: {
-                validators: {
-                    notEmpty: {
-                        message: 'The date is required and cannot be empty'
-                    },
-                    date: {
-                        format: 'MM/DD/YYYY h:m A'
-                    }
-                }
-            }
-        }
-    });
-
-    $('#datetimePicker')
-        .on('dp.change dp.show', function(e) {
-            // Validate the date when user change it
-            $('#defaultForm')
-                // Get the bootstrapValidator instance
-                .data('bootstrapValidator')
-                // Mark the field as not validated,
-                // so it'll be re-validated when the user change date
-                .updateStatus('datetimePicker', 'NOT_VALIDATED', null)
-                // Validate the field
-                .validateField('datetimePicker');
-        });
-});
-</script>
-```
-
-### ```enableFieldValidators```
-
-```enableFieldValidators(field, enabled)```: Enable/disable all validators to given field
-
-Parameter | Description
-----------|------------
-field     | The field name
-enabled   | If ```true```, enable field validators. If ```false```, disable field validators
-
-### ```resetForm```
-
-```resetForm(resetFormData)```: Reset form. It hides all error elements and feedback icons. All the fields are marked as not validated yet.
-If ```resetFormData``` is ```true```, the method resets the fields which have validator rules.
-
-```javascript
-$(form).bootstrapValidator(options);
-$(form).data('bootstrapValidator').resetForm();
-```
-
-## Write new validator
-
-> If you develop new validator which might be useful to other, please [fork](https://github.com/nghuuphuoc/bootstrapvalidator/fork) and pull a new request.
-> Then I will add it as a built-in validator
-
-A validator has to follow the syntax:
-
-```javascript
-(function($) {
-    $.fn.bootstrapValidator.validators.<validatorName> = {
-        /**
-         * @param {BootstrapValidator} validator The validator plugin instance
-         * @param {jQuery} $field The jQuery object represents the field element
-         * @param {Object} options The validator options
-         * @returns {boolean}
-         */
-        validate: function(validator, $field, options) {
-            // You can get the field value
-            // var value = $field.val();
-            //
-            // Perform validating
-            // ...
-            //
-            // return true if the field value is valid
-            // otherwise return false
-        }
-    };
-}(window.jQuery));
-```
-
-```<validatorName>``` is the validator name.
-Since the validators are distinct by the names, ```<validatorName>``` has to be different with [built-in validators](#validators).
-
-To apply the validator to particular field:
-
-```javascript
-$(form).bootstrapValidator({
-    fields: {
-        <fieldName>: {
-            // Replace <validatorName> with the name of validator
-            // <validatorOptions> will be passed as third parameter of the
-            // validate(validator, $field, options) method
-            <validatorName>: <validatorOptions>
-        }
-    }
-});
-```
-
-For Rails, the input field is constructed from model name and field name. For example, user have email as field, when form helper render
-view, the input field name will be ```'user[email]'```. The syntax for these is somewhat different as shown below:
-
-```javascript
-$(form).bootstrapValidator({
-    fields: {
-        'user[email]': {
-            // Replace <validatorName> with the name of validator
-            // <validatorOptions> will be passed as third parameter of the
-            // validate(validator, $field, options) method
-            <validatorName>: <validatorOptions>
-        }
-    }
-});
-```
-
-To see how built-in validators are developed, you can look at their sources located at the [```src/js/validator```](src/js/validator) directory.
-
-## Build
-
-BootstrapValidator uses [grunt](http://gruntjs.com) to simplify building process.
-
-From the BootstrapValidator root directory, install dependencies:
-
-```bash
-$ npm install
-```
-
-Then, uses grunt to build:
-
-```bash
-$ grunt
-```
-
-If you want grunt to generate scripts whenever the original scripts (located in ```src```) change, use the following command:
-
-```bash
-$ grunt watch
-```
-
-The generated scripts (including source and compressed versions) are placed inside the ```dist``` directory.
+* [Official website](http://bootstrapvalidator.com)
+* [Official website source](https://github.com/nghuuphuoc/bootstrapvalidator/tree/gh-pages)
 
 ## Release History