From 42f8098ae3e85de25b1b70cdf1b55932bc5dcf59 Mon Sep 17 00:00:00 2001 From: Borales Date: Wed, 10 Jun 2015 19:54:43 +0200 Subject: [PATCH] README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4e8402 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +Yii2 International telephone numbers - Asset Bundle, Behavior, Validator, Widget +================================================================================ + +[![Latest Stable Version](https://poser.pugx.org/borales/yii2-phone-input/v/stable.svg)](https://packagist.org/packages/borales/yii2-phone-input) +[![Total Downloads](https://poser.pugx.org/borales/yii2-phone-input/downloads.svg)](https://packagist.org/packages/borales/yii2-phone-input) +[![Latest Unstable Version](https://poser.pugx.org/borales/yii2-phone-input/v/unstable.svg)](https://packagist.org/packages/borales/yii2-phone-input) +[![License](https://poser.pugx.org/borales/yii2-phone-input/license.svg)](https://packagist.org/packages/borales/yii2-phone-input) + +This extension uses 2 libraries: + +- [A jQuery plugin for entering and validating international telephone numbers](https://github.com/Bluefieldscom/intl-tel-input) +- [PHP version of Google's phone number handling library](https://github.com/giggsey/libphonenumber-for-php) + +Original demo can be found here - [http://jackocnr.com/intl-tel-input.html](http://jackocnr.com/intl-tel-input.html). + +## Installation + +The preferred way to install this extension is through [composer](http://getcomposer.org/download/). + +Either run + +```bash +$ php composer.phar require "borales/yii2-phone-input" "*" +``` + +or add + +``` +"borales/yii2-phone-input": "*" +``` + +to the `require` section of your `composer.json` file. + +## Usage + +Docs will be available soon... \ No newline at end of file