Fix #21 Update README

.npmignore

@@ -0,0 +1,17 @@
+# Logs
+*.log
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Dependency directories
+node_modules
+
+hubot.db
+
+.vscode
+
+/media

Dockerfile

@@ -6,4 +6,4 @@ ARG version
 
 RUN npm install -g hubot.js@$version
 
-CMD hubot start --t $BOT_API_KEY --n $BOT_NAME && tail -F -n0 /etc/hosts
+CMD hubot start --t $BOT_API_TOKEN --n $BOT_NAME && tail -F -n0 /etc/hosts

README.md

@@ -1,90 +1,126 @@
-# hubot.js 
-[![Build Status](https://travis-ci.org/hubot-js/hubot.js.svg?branch=master)](https://travis-ci.org/hubot-js/hubot.js)  [![Coverage Status](https://coveralls.io/repos/github/hubot-js/hubot.js/badge.svg?branch=master)](https://coveralls.io/github/hubot-js/hubot.js?branch=master)   [![Code Climate](https://img.shields.io/codeclimate/github/hubot-js/hubot.js.svg)](https://codeclimate.com/github/hubot-js/hubot.js)  [![dependencies-badge](https://david-dm.org/hubot-js/hubot.js.svg)](https://david-dm.org/hubot-js/hubot.js)  [![devDependencies Status](https://david-dm.org/hubot-js/hubot.js/dev-status.svg)](https://david-dm.org/hubot-js/hubot.js?type=dev)  [![Docker Stars](https://img.shields.io/docker/stars/robsonbittencourt/hubot.js.svg)](https://hub.docker.com/r/robsonbittencourt/hubot.js/)  [![Docker Pulls](https://img.shields.io/docker/pulls/robsonbittencourt/hubot.js.svg)](https://hub.docker.com/r/robsonbittencourt/hubot.js/)  [![image-size](https://images.microbadger.com/badges/image/robsonbittencourt/hubot.js.svg)](http://microbadger.com/images/robsonbittencourt/hubot.js)
-
-> A small robot written in Javascript (He doesn't like coffeescript)
-
-## Hello world
-
-Hello! My name is Hubot. I'm a robot and my job is to do stuff in Slack chats. At first, I don't know many things, but when gears are attached everything is possible. I love new gears. Feel free to create them.
-
-![start-deploy-gif](https://s10.postimg.org/jl5ptldnt/hubot_start_deploy2.gif)
-
-## How to turn me on?
-
-The first step is to create a bot user on Slack. For this, you can follow [these steps](https://api.slack.com/bot-users). With a bot user created and the token on hand we can go to the next step.
-
-### Docker
-
-To enable me with Docker it's a piece of cake. I have a recipe of how to build me in [Dockerhub](https://hub.docker.com/r/robsonbittencourt/hubot.js/). Just run the following command:
-
-```
-docker run -d -e BOT_API_KEY=your_slack_api_key \
-   -e BOT_NAME=name_of_your_bot \
-   --restart="unless-stopped"
-   --name=hubot \
-   robsonbittencourt/hubot.js
-```
-
-### Node.js
-
-If you don't use Docker no problem. You can turn me on using Node.js commands. For this set variables before node command.
-
-```
-BOT_API_KEY=your_slack_api_key BOT_NAME=name_of_your_bot node app.js
-
-```
-
-## Usage
-
-For now, I don't know how to do many things. But I'm able to understand and to use new gears (features). You can create your own gears. If you think they can be useful for other users, please share it with the world.
-
-### Jenkins
-
-I know  how to invoke your jobs in Jenkins. For this, you need to enter your authorization link to build me.
-
-```
-docker run -d -e BOT_API_KEY=your_slack_api_key \
-   -e BOT_NAME=name_of_your_bot \
-   -e JENKINS_AUTH_URL=your_jenkins_auth_url \
-   --restart="unless-stopped" \
-   --name=hubot \
-   robsonbittencourt/hubot.js
-```
-If you use Jenkins without security (authentication) the authorization link is simply the access url. For example: `http://your.jenkins.com:8080`
-
-If you use the Jenkins authentication, you need to find your access token. It can be obtained from `yourJenkinsUrl/me/configure`. See more details [here](https://wiki.jenkins-ci.org/display/JENKINS/Authenticating+scripted+clients). In this case your authorization link should be in this format: `http://your_user:your_token@your_jenkins_url`
-
-After that, you can ask me to do your jobs.
-
-```
-hubot start job my-deploy
-```
-
-![start-deploy](https://s9.postimg.org/g9dt1se9b/hubot_job.png)
-
-### Help
-
-If you have doubt about the available commands, please ask me for help. I'll be glad to use my gears and knowledge to answer your questions.
-
-```
-hubot help
-```
-
-![hubot-help](https://s9.postimg.org/rf26x119b/hubot_help.png)
-
-## Development setup
-- Fork and clone this project
-- In the main directory run ```npm install```to install dependencies.
-- Use node command (see before) for run Hubot.js
-- Write your code
-- To run tests use ```npm test``` command
-
-## Contributors
-[Robson Rosa](https://github.com/robsonrosa)
-
-## Meta
-Robson Bittencourt - @rluizv - [email protected]
-
-Distributed under the MIT license. See [LICENSE](LICENSE) for more information.
-
-https://github.com/robsonbittencourt/hubot.js
+# hubot.js 
+[![Build Status](https://travis-ci.org/hubot-js/hubot.js.svg?branch=master)](https://travis-ci.org/hubot-js/hubot.js)   [![npm](https://img.shields.io/npm/v/gear-hubot.js.svg)](https://www.npmjs.com/package/hubot.js)   [![Coverage Status](https://coveralls.io/repos/github/hubot-js/hubot.js/badge.svg?branch=master)](https://coveralls.io/github/hubot-js/hubot.js?branch=master)   [![Code Climate](https://img.shields.io/codeclimate/github/hubot-js/hubot.js.svg)](https://codeclimate.com/github/hubot-js/hubot.js)  [![dependencies-badge](https://david-dm.org/hubot-js/hubot.js.svg)](https://david-dm.org/hubot-js/hubot.js)  [![devDependencies Status](https://david-dm.org/hubot-js/hubot.js/dev-status.svg)](https://david-dm.org/hubot-js/hubot.js?type=dev)  [![Docker Stars](https://img.shields.io/docker/stars/robsonbittencourt/hubot.js.svg)](https://hub.docker.com/r/robsonbittencourt/hubot.js/)  [![Docker Pulls](https://img.shields.io/docker/pulls/robsonbittencourt/hubot.js.svg)](https://hub.docker.com/r/robsonbittencourt/hubot.js/)  [![image-size](https://images.microbadger.com/badges/image/robsonbittencourt/hubot.js.svg)](http://microbadger.com/images/robsonbittencourt/hubot.js)
+
+> A small robot written in Javascript (He doesn't like coffeescript)
+
+## Hello world
+
+Hello! My name is Hubot. I'm a robot and my job is to do stuff in Slack chats. At first, I don't know many things, but when gears are attached everything is possible. I love new gears. Feel free to create them.
+
+![start-deploy-gif](media/start-job.gif)
+
+## How to turn me on?
+
+The first step is to have a bot user in Slack. If you don't have a bot yet [click here](https://api.slack.com/bot-users) to create one. With a bot user created get the token that was generated in the bot creation and go to the next step.
+
+### npm
+
+Very simple. Run the command below.
+
+```bash
+npm install -g hubot.js
+```
+
+### Docker
+
+To enable me with Docker it's a piece of cake. I have a recipe of how to build me in [Dockerhub](https://hub.docker.com/r/robsonbittencourt/hubot.js/). Just run the following command:
+
+```bash
+docker run -d -e BOT_API_TOKEN=bot_token \
+              -e BOT_NAME=bot_name \
+              --name=hubot \
+              robsonbittencourt/hubot.js
+```
+
+## Usage
+
+After you install me through npm some commands are avaliable in your command line. If you start me with Docker these commands won't are available. Help and configure are commands exclusively for console with npm installation. The other commands can be executed with Docker commands - like docker start/stop/restart.
+
+### CLI Commands Overview 
+
+```bash
+# Show the help with available commands
+$ hubot help                              
+
+# Saves the required settings. These settings are stored, so you just need to do them once.
+# But if necessary can make them again.
+$ hubot configure -t botToken -n botName  
+
+# Start the hubot. To use this command, the settings must have been already set up.
+$ hubot start                             
+
+# Start the hubot. This command saves the configuration and starts. 
+$ hubot start -t botToken -n botName      
+
+# Stop the hubot.
+$ hubot stop                              
+
+# Restart the hubot.
+$ hubot restart                           
+```
+
+### First iteration
+
+After you start me call me by my name in private chat. With this I show to you some first instructions.
+
+![first-iteraction](media/first-iteraction.png)
+
+**_An important detail. To ask me things on a channel I have to be participating in it._**
+
+### Activate/Deactivate Gears
+
+You don't want to use some gear? You can disable it. If you want to activate it again it is also possible. Use `activate gear-name` or `deactivate gear-name`.
+
+![activate-deactivate-gear](media/activate-deactivate-gear.gif)
+
+### Configure Gears
+
+Some gears need to be set up before first use. Use `configure gear-name` command.
+
+![configure-gear](media/configure-gear.gif)
+
+## Gears
+
+For now, I don't know how to do many things. But I'm able to understand and to use new gears (features). You can create your own gears. If you think they can be useful for other users, please share it with the world.
+
+### Jenkins
+
+I know how to invoke your jobs in Jenkins. For this, you need to do the setup before.
+
+```
+configure jenkins
+```
+
+After that, you can ask me to do your jobs.
+
+```
+hubot start job my-deploy
+```
+
+![start-job](media/start-job.png)
+
+### Help
+
+If you have doubt about the available commands, please ask me for help. I'll be glad to use my gears and knowledge to answer your questions.
+
+```
+hubot help
+```
+
+![help](media/help.png)
+
+## Development setup
+- Fork and clone this project
+- In the main directory run ```npm install```to install dependencies.
+- Write your code
+- To run tests use ```npm test``` command
+
+## Contributors
+[Robson Rosa](https://github.com/robsonrosa)
+
+## Meta
+Robson Bittencourt - @rluizv - [email protected]
+
+Distributed under the MIT license. See [LICENSE](LICENSE) for more information.
+
+https://github.com/hubot-js/hubot.js