burrp - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

package.json

 {
     "name": "burrp",
-    "version": "0.0.2",
+    "version": "0.1.0",
     "description": "A tiny cli app to generate food names.",
     "private": false,
     "bin": {
-        "burrp": "./bin/burrp"
+        "burrp": "./bin/burrp",
+        "burp": "./bin/burrp"
     },
@@ -25,3 +26,3 @@ "scripts": {
     "homepage": "https://github.com/umayr/burrp#readme",
-    "main": "bin/burrp",
+    "main": "./lib/index",
     "directories": {
@@ -28,0 +29,0 @@ "test": "test"

Readme.md

@@ -10,4 +10,6 @@ Burrp
 
-To install burrp from npm, run:
+##### Command Line:
 
+To install burrp globally from npm, run:
+
 ```
@@ -17,8 +19,8 @@ $ npm install -g burrp
 
-Once its installed try:
+Once its installed, it can be used via command line. Try:
 ```
-$ burrp -V
-0.0.2
+$ burp -V
+0.1.0
 
-$ burrp -h
+$ burp -h
 
@@ -33,6 +35,6 @@ Usage: burrp [options]
 
-$ burrp
+$ burp
 White Wine and Walnut Tart
 
-$ burrp
+$ burp
 Strawberry and Coconut Pie
@@ -50,2 +52,21 @@ Dark Chocolate and Ginger Mooncake
 ```
+Note: This package registers two commands, `burrp` & `burp`. You can use either of those for cli.
+
+#### Programmatically
+
+To install burrp as a dependency:
+
+```
+$ npm install --save burrp
+```
+
+Then use it as:
+
+``` javascript
+var burp = require('burrp').burp;
+
+burp();
+// [ "Fire-Grilled Honey & Thyme Boar" ]
+```
+
 ### Tests
@@ -52,0 +73,0 @@

No alert changes

Improved metrics

Total package byte prevSize

14780

increased by10.54%

Number of package files

10

increased by25%

Lines of code

190

increased by196.88%

Number of lines in readme file

84

increased by33.33%

No dependency changes