diff --git a/README.md b/README.md index b2f7c9ec..03e7eff9 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,2 @@ firebase-tools ============ - -These are the Firebase Command Line Tools for administering your account and interacting with the Firebase Hosting beta. - -## 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 -```shell -npm install -g firebase-tools -``` -This will install the globally accessible command `firebase` -## Commands -The command `firebase --help` lists the available commands and their optional parameters: - -```shell -Firebase Command Line Tools -Version 0.0.1 -https://www.firebase.com - -Usage: firebase - - Available commands are: - - login - Authenticates with the Firebase servers and stores an access token locally. - All commands that require authentication use this if no valid access token - exists. - --email The email address of the account to attempt to log in with. - --password The password of the account to attempt to log in with. - - logout - Invalidates and destroys any locally stored access tokens. - -d Optional flag to delete the settings file. - - list - Lists the Firebases available to the currently logged in user. - - app init - Initializes a Firebase app in the current directory. - -f, --firebase The name of the Firebase to initialize the app with. - -p, --public A directory containing all of the app's static files that - should deployed to Firebase Hosting. Defaults to the current - directory. - -r, --rules An optional file that contains security rules for the - Firebase. - - app bootstrap - Creates a new Firebase app from a number of predetermined templates to - quickly get a project up and running. Creates a new folder named after the - Firebase it is initialized with. - -f, --firebase The name of the Firebase to initialize the app with. - -t, --template The name of the template to initialize the app with. - - app deploy - Publishes the app in the current directory to Firebase Hosting. If a file - containing the security rules has been provided, these are uploaded to the - server. -``` -## Credit -Inspired by [Luke Vivier](https://github.com/lvivier)'s Firebase command line tools. diff --git a/package.json b/package.json index fd772068..382f3ebf 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "firebase-tools", "preferGlobal": true, - "version": "0.0.1", + "version": "0.0.2", "description": "The Firebase Command Line Tools", "keywords": [ "firebase"