firebase-tools - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

CHANGELOG.md

@@ -0,1 +1,4 @@
+## v1.1.1
+- Adds a brief description of each template inline when running `firebase bootstrap`
+
 ## v1.1.0
@@ -2,0 +5,0 @@ - Supports new advanced features parameters in the `firebase.json` to allow greater customization of hosting parameters

lib/app.js

@@ -331,3 +331,23 @@ var request = require('request'),
             console.log(chalk.yellow('----------------------------------------------------'));
-            console.log(templateList.join('\n'));
+
+            var longestTemplateLength = 0;
+            for (var i = 0; i < templateList.length; i++) {
+              if (templateList[i].length > longestTemplateLength) {
+                longestTemplateLength = templateList[i].length;
+              }
+            }
+            for (var i = 0; i < templateList.length; i++) {
+              var key = templateList[i],
+                  template = supportedTemplates[key];
+              var output = chalk.bold(key);
+              if (template.description) {
+                var spacingString = '';
+                for (var j = longestTemplateLength; j > key.length; j--) {
+                  spacingString += ' ';
+                }
+                output += spacingString + ' - ' + template.description;
+              }
+              console.log(output);
+            }
+
             console.log(chalk.yellow('----------------------------------------------------'));
@@ -334,0 +354,0 @@ console.log('Choose a template to help you get started with your app');

package.json

 {
   "name": "firebase-tools",
   "preferGlobal": true,
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "The Firebase Command Line Tools",
@@ -6,0 +6,0 @@ "keywords": [

README.md

@@ -1,23 +0,33 @@
-firebase-tools
-============
+# firebase-tools
 
-These are the Firebase Command Line Tools. They can be used to: 
+[![NPM version](https://badge.fury.io/js/firebase-tools.svg)](http://badge.fury.io/js/firebase-tools)
+
+These are the Firebase Command Line (CLI) Tools. They can be used to:
+
 * Administer your Firebase account
-* Interact with [Firebase Hosting](https://www.firebase.com/hosting.html), our product to host your HTML, JS, images, etc.
+* Interact with [Firebase Hosting](https://www.firebase.com/hosting.html), our product to host your HTML, JS, CSS, images, etc.
 
-For a quick start guide, see https://www.firebase.com/docs/hosting.html
+To get started with the Firebase CLI, [read through our hosting quickstart guide](https://www.firebase.com/docs/hosting.html).
 
+## Installation
 
-## Installation
-To install, first you'll need to [sign up](https://www.firebase.com/signup/) for
-a Firebase account and have installed [Node.js](http://nodejs.org/) and
-[npm](https://npmjs.org/). Then run
+To install the Firebase CLI, you first need to [sign up for a Firebase account](https://www.firebase.com/signup/).
+Then you need to install [Node.js](http://nodejs.org/) and [npm](https://npmjs.org/).
+Note that installing Node.js should install npm as well.
+
+Once npm is installed, get the Firebase CLI by running the following shell command:
+
 ```shell
 npm install -g firebase-tools
 ```
-This will install the globally accessible command `firebase`
+
+This will provide you with the globally accessible `firebase` command.
+
 ## Commands
+
 The command `firebase --help` lists the available commands and
-`firebase <command> --help` shows more details.
+`firebase <command> --help` shows more details for an individual command.
 
+Here is the output of running `firebase --help`:
+
 ```shell
@@ -46,3 +56,3 @@ Usage: firebase <command>
     Lists the Firebases available to the currently logged in user.
-    
+
   delete-site
@@ -72,6 +82,6 @@ Deletes the current app from Firebase Hosting and displays a
 ## Credit
-Inspired by [Luke Vivier](https://github.com/lvivier)'s Firebase command line tools.
 
-License
--------
+Inspired by [Luke Vivier](https://github.com/lvivier/)'s Firebase command line tools.
+
+## License
 [MIT](http://firebase.mit-license.org)

No alert changes

Improved metrics

Total package byte prevSize

63473

increased by5.91%

Number of package files

12

increased by9.09%

Lines of code

1378

increased by1.32%

Number of lines in readme file

86

increased by13.16%

No dependency changes