Merge branch 'release/0.2.1'

README.md

@@ -41,48 +41,51 @@ Usage
 
 ### Hash a password
 
-```php
-use ModDev\Password\Scrypt;
+    <?php
+    use ModDev\Password\Scrypt;
     
-$scrypt = new Scrypt();
-$securePass = $scrypt->create('user password');
-```
+    $scrypt = new Scrypt();
+    $securePass = $scrypt->create('user password');
 
 ### Check the hashed password against an user input
 
-```php
-use ModDev\Password\Scrypt;
+    <?php
+    use ModDev\Password\Scrypt;
     
-$scrypt = new Scrypt();
-$securePass = 'the stored scrypt value';
-$password = 'the password to check';
+    $scrypt = new Scrypt();
+    $securePass = 'the stored scrypt value';
+    $password = 'the password to check';
     
-if ($scrypt->verify($password, $securePass)) {
+    if ($scrypt->verify($password, $securePass)) {
         echo "The password is correct! \n";
-} else {
+    } else {
         echo "The password is NOT correct.\n";
-}
-
-```
+    }
 
 ### Optional Parameters
 
-```php
-use ModDev\Password\Scrypt;
+    <?php
+    use ModDev\Password\Scrypt;
     
-$scrypt = new Scrypt(array(
+    $scrypt = new Scrypt(array(
         'cpuDifficulty'      => 16384, //The CPU difficulty. Also called "N" in scrypt documentation. Must be a power of 2.
         'memoryDifficulty'   => 8, //The memory difficulty. Also called "r" in scrypt documentation.
         'parallelDifficulty' => 1, //The parallel difficulty. Also called "p" in scrypt documentation.
         'keyLength'          => 32, //The key length. Must be greater or equal to 16.
-));
-```
+    ));
 
 ### Return the hash algorithm
 
-```php
-use ModDev\Password\Scrypt;
+    <?php
+    use ModDev\Password\Scrypt;
     
-$scrypt = new Scrypt();
-$passwordhashType = $scrypt->getHashType($hashedPassword);
-```
+    $scrypt = new Scrypt();
+    $passwordhashType = $scrypt->getHashType($hashedPassword);
+
+### Check if the password needs rehashing
+
+    <?php
+    use ModDev\Password\Scrypt;
+    
+    $scrypt = new Scrypt();
+    echo $scrypt->needsRehash($hashedPassword);