From 3848e7831c7168ab5aa264c021f3756b23def060 Mon Sep 17 00:00:00 2001 From: Marcus Olsson Date: Mon, 7 Nov 2016 17:18:18 +0100 Subject: [PATCH] Fixed major flaw in documentation. --- LICENSE.md | 2 +- README.md | 37 ++++++++++++++++++++++--------------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 9134fe3..e4671f0 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # The MIT License (MIT) -Copyright (c) 2015 Marcus Olsson +Copyright (c) 2016 Marcus Olsson > Permission is hereby granted, free of charge, to any person obtaining a copy > of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 41e30ed..057c71c 100644 --- a/README.md +++ b/README.md @@ -40,22 +40,23 @@ If you've added `Olssonm\Zxcvbn` as an alias, your can access Zxcvbn easily from ``` php passwordStrength('password')); + $zxcvbn = Zxcvbn::passwordStrength('password'); + dd($zxcvbn); - // array:6 [ - // "crack_time" => 5.0E-5 - // "calc_time" => 0.1857271194458 - // "password" => "password" - // "entropy" => 0.0 - // "match_sequence" => array:1 [] - // "score" => 0 + // array:6 [▼ + // "crack_time" => 5.0E-5 + // "calc_time" => 0.12961101531982 + // "password" => "password" + // "entropy" => 0.0 + // "match_sequence" => array:1 [] + // "score" => 0 // ] } } @@ -72,8 +73,11 @@ The package gives you two different validation rules that you may use; `zxcvbn_m `zxcvbn_min` allows you to set up a rule for minimum score that the value beeing tested should adhere to. -***Syntax*** -`'input' => 'zxcvbn_min:min_value'` +**Syntax** + + input' => 'zxcvbn_min:min_value' + +**Example** ``` php 'xcvbn_dictionary:username,email'` +**Syntax** + + 'input' => 'xcvbn_dictionary:username,email' + +**Example** ``` php