meow - npm Package Compare versions

Comparing version 3.4.2 to 3.5.0

index.js

@@ -43,4 +43,9 @@ 'use strict';
 
-	help = '\n  ' + pkg.description + (help ? '\n\n' + help : '\n');
+	var description = opts.description;
+	if (!description && description !== false) {
+		description = pkg.description;
+	}
 
+	help = (description ? '\n  ' + description + '\n' : '') + (help ? '\n' + help : '\n');
+
 	var showHelp = function (code) {
@@ -47,0 +52,0 @@ console.log(help);

package.json

 {
   "name": "meow",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "CLI app helper",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -82,2 +82,11 @@ # meow [![Build Status](https://travis-ci.org/sindresorhus/meow.svg?branch=master)](https://travis-ci.org/sindresorhus/meow)
 
+##### description
+
+Type: `string`, `boolean`
+Default: The package.json `"description"` property
+
+A description to show above the help text.
+
+Set it to `false` to disable it altogether.
+
 ##### help
@@ -94,5 +103,5 @@
 
-If you don't specify anything, it will still show the package.json `"description"`.
+The description will be shown above your help text automatically.
 
-Set it to `false` to disable it all together.
+Set it to `false` to disable it altogether.
 
@@ -106,3 +115,3 @@ ##### version
 
-Set it to `false` to disable it all together.
+Set it to `false` to disable it altogether.
 
@@ -109,0 +118,0 @@ ##### pkg

No alert changes

Improved metrics

Total package byte prevSize

7530

increased by4.24%

Lines of code

59

increased by7.27%

Number of lines in readme file

158

increased by6.04%

No dependency changes