feat(laravel-password): Add password check functionality

Author: unicodeveloper

README.md

@@ -1,50 +1,89 @@
-# :package_name
+# laravel-password
 
-[![Latest Version on Packagist][ico-version]][link-packagist]
-[![Software License][ico-license]](LICENSE.md)
-[![Build Status][ico-travis]][link-travis]
-[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
-[![Quality Score][ico-code-quality]][link-code-quality]
-[![Total Downloads][ico-downloads]][link-downloads]
+[![Latest Stable Version](https://poser.pugx.org/unicodeveloper/laravel-password/v/stable.svg)](https://packagist.org/packages/unicodeveloper/laravel-password)
+[![License](https://poser.pugx.org/unicodeveloper/laravel-password/license.svg)](LICENSE.md)
+[![Quality Score](https://img.shields.io/scrutinizer/g/unicodeveloper/laravel-password.svg?style=flat-square)](https://scrutinizer-ci.com/g/unicodeveloper/laravel-password)
+[![Total Downloads](https://img.shields.io/packagist/dt/unicodeveloper/laravel-password.svg?style=flat-square)](https://packagist.org/packages/unicodeveloper/laravel-password)
 
-This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
-PSRs you support to avoid any confusion with users and contributors.
+> #### Guard your users from security problems such as being hacked that start by having dumb passwords
 
-## Install
+### Introduction
 
-Via Composer
+This package can be used to verify **the user provided password is
+not one of the top 10,000 worst passwords** as analyzed by a respectable IT security analyst. Read
+about all [ here](https://xato.net/10-000-top-passwords-6d6380716fe0#.473dkcjfm),
+[here(wired)](http://www.wired.com/2013/12/web-semantics-the-ten-thousand-worst-passwords/) or
+[here(telegram)](http://www.telegraph.co.uk/technology/internet-security/10303159/Most-common-and-hackable-passwords-on-the-internet.html)
 
-``` bash
-$ composer require unicodeveloper/laravel-password
+
+## Installation
+
+[PHP](https://php.net) 5.5+ or [HHVM](http://hhvm.com) 3.3+, and [Composer](https://getcomposer.org) are required.
+
+To get the latest version of Laravel Password, simply add the following line to the require block of your `composer.json` file.
+
+```
+"unicodeveloper/laravel-password": "1.0.*"
 ```
 
-## Usage
+You'll then need to run `composer install` or `composer update` to download it and have the autoloader updated.
+
+Once Laravel Password is installed, you need to register the service provider. Open up `config/app.php` and add the following to the `providers` key.
+
+* `Unicodeveloper\DumbPassword\DumbPasswordServiceProvider::class`
+
 
-``` php
+## Usage
 
+Use the rule `dumbpwd` in your validation like so:
+
+```php
+/**
+ * Get a validator for an incoming registration request.
+ *
+ * @param  array  $data
+ * @return \Illuminate\Contracts\Validation\Validator
+ */
+protected function validator(array $data)
+{
+    return Validator::make($data, [
+        'name' => 'required|max:255',
+        'email' => 'required|email|max:255|unique:users',
+        'password' => 'required|min:6|dumbpwd|confirmed',
+    ]);
+}
 ```
 
-## Change log
+Results happen like so:
 
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+<img width="1101" alt="screen shot 2016-07-02 at 1 10 22 pm" src="https://cloud.githubusercontent.com/assets/2946769/16540466/be96cd5c-405d-11e6-9412-35a89da03edd.png">
+
+<img width="1095" alt="screen shot 2016-07-02 at 1 22 45 pm" src="https://cloud.githubusercontent.com/assets/2946769/16540468/c6bd71f2-405d-11e6-8f34-d3a9b1b27e77.png">
+
+By default, the error message returned is `This password is just too common. Please try another!`.
 
-## Testing
+You can customize the error message by opening `resources/lang/en/validation.php` and adding it like so:
 
-``` bash
-$ composer test
+```php
+  'dumbpwd'              => 'You are using a dumb password abeg',
 ```
 
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
+Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
 
-## Security
+## How can I thank you?
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!
 
-## Credits
+Don't forget to [follow me on twitter](https://twitter.com/unicodeveloper)!
 
-- [Prosper Otemuyiwa][https://twitter.com/unicodeveloper]
+Thanks!
+Prosper Otemuyiwa.
 
 ## License