README

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stephen Ball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,31 @@
-# {{project}}
+# Laravel Zxcvbn validator
+
+This package providers a validator which uses dropbox's [zxcvbn](https://github.com/dropbox/zxcvbn) 
+password strength estimator; it uses the [PHP implementation](https://github.com/bjeavons/zxcvbn-php) from
+[bjeavons](https://github.com/bjeavons). 
+
+## Installation
+
+This package can be installed through Composer.
+
+``` bash
+composer require rebelinblue/laravel5-zxcvbn
+```
+
+In Laravel 5.5 the package will auto-register the service provider. In Laravel 5.4 you must register this 
+service provider manually in `config/app.php` by adding `REBELinBLUE\Zxcvbn\ZxcvbnServiceProvider::class` to the 
+`providers` array
+
+
+There is also an optional facade for Zxcvbn; in Laravel 5.5 it will be auto-registered. In Laravel 5.4
+you must register the facade manually by adding the following to the `aliases` array in `config/app.php`
+
+```php
+    'Zxcvbn' => REBELinBLUE\Zxcvbn\ZxcvbnFacade::class,
+```
+
+Optionally, you can publish the translations for this package with, however it is only required if you wish to change them
+
+``` bash
+php artisan vendor:publish --provider="REBELinBLUE\Zxcvbn\ZxcvbnServiceProvider"
+```

src/ZxcvbnValidator.php

@@ -86,6 +86,7 @@ private function getMatchFeedback($match, $isOnlyMatch)
             return $this->$strategy($match, $isOnlyMatch);
         }
 
+        // FIXME: This should not happen
         return $strategy;
     }