credential-plus - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

package.json

 {
   "name": "credential-plus",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Password hashin and verification made easy!",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -24,5 +24,11 @@ <h1 align="center">
 
-## Intro
+## Background
 
+Over the past several years, we've seen major breaches exposing numerous
+usernames and passwords. With every password breach comes the inevitable
+question: Were the passwords stored securely?
 
+This package aim to provide secure, well configured and ready to use password
+hashing algorithms for your application.
+
 ## Install
@@ -42,4 +48,4 @@
 bcrypt | [credential-plus-bcrypt](https://github.com/simonepri/credential-plus-bcrypt)
-scrypt |  [credential-plus-scrypt](https://github.com/simonepri/credential-plus-scrypt)
-argon2 |  [credential-plus-argon2](https://github.com/simonepri/credential-plus-argon2)
+scrypt | [credential-plus-scrypt](https://github.com/simonepri/credential-plus-scrypt)
+argon2 | [credential-plus-argon2](https://github.com/simonepri/credential-plus-argon2)
 
@@ -111,6 +117,6 @@ In the next section we will use `pbkdf2` for examples, replace it with your choice if differs.
 
-**Kind**: global function
+**Kind**: global function  
 **Returns**: <code>Promise.&lt;string&gt;</code> - A promise that contains a stringified object
  that holds the generated hash string, the name of the function used to hash
- it.
+ it.  
 **Access**: public
@@ -137,5 +143,5 @@
 
-**Kind**: global function
+**Kind**: global function  
 **Returns**: <code>Promise.&lt;boolean&gt;</code> - A promise that contains a boolean that is true if
-  if the hash computed for the input matches.
+  if the hash computed for the input matches.  
 **Access**: public
@@ -153,3 +159,3 @@
 
-**Kind**: global function
+**Kind**: global function  
 **Access**: public
@@ -164,4 +170,4 @@
 ## list() ⇒ <code>array</code>
-**Kind**: global function
-**Returns**: <code>array</code> - The array of the available hash functions.
+**Kind**: global function  
+**Returns**: <code>array</code> - The array of the available hash functions.  
 **Access**: public
@@ -168,0 +174,0 @@

No alert changes

Improved metrics

Total package byte prevSize

103105

increased by0.32%

Number of lines in readme file

176

increased by3.53%

No dependency changes