xkpasswd - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "xkpasswd",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Memorable password generator, inspired by a PERL module powering xkpasswd.net/s/",
   "main": "index.js",
   "bin": {
+    "xkp": "cli.js",
     "xkpasswd": "cli.js"
@@ -8,0 +9,0 @@ },

readme.md

@@ -1,2 +0,2 @@
-Memorable password generator, inspired by a PERL module powering xkpasswd.net/s/
+*Memorable password generator, inspired by a PERL module powering xkpasswd.net/s/*
 
@@ -6,18 +6,65 @@
 
-Use as any node module.
+You can use xkpasswd as a module in your application.
 
+**EXAMPLE**
+
 ```
 var xkpasswd = require('xkpasswd');
-console.log('Default options:', xkpasswd());
-console.log('Custom pattern:', xkpasswd({pattern: 'DDSwSwSwSDD'}));
+
+console.log(xkpasswd());
+valuable=bear=difference=53
+
+console.log(xkpasswd({complexity: 5, separators: '#+-'}));
+#addition#wheat#congress#manner#lonely#20
+
 ```
 
+
+<br>
+
 You can also use xkpasswd command in your terminal if you install it globally.
 
+**CLI OPTIONS**
+
 ```
-npm install xkpasswd -g
-xkpasswd
+xkpasswd [complexity] [separators] --pattern --number
 ```
 
+*xkp* alias for this task is also defined and is used in examples below.
 
+<br>
+
+**EXAMPLE** Default behaviour
+
+```
+$ xkp
+
+hide+threw+money+61
+```
+
+**EXAMPLE** Specify complexity
+
+```
+$ xkp 4
+
+=join=industrial=wide=direction=lungs=16
+```
+
+**EXAMPLE** Specify complexity, custom separators and number of passwords
+
+```
+$ xkp 3 '#!+' -n 5
+
+Passwords:
+---------------------------------
+dog!friend!successful!47
+he!advice!deer!40
+other#sell#close#01
+stepped+specific+hurry+00
+five#duck#blanket#21
+---------------------------------
+```
+
+<br>
+
 ## Issues and requests
@@ -28,1 +75,3 @@
 You can also just go ahead and add a feature yourself, simply create a pull request.
+
+<br>

No alert changes

Improved metrics

Total package byte prevSize

5204

increased by15.44%

Number of lines in readme file

75

increased by177.78%

No dependency changes