hubot-slack - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

package.json

 {
   "name": "hubot-slack",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "author": {
@@ -45,3 +45,10 @@ "name": "Tiny Speck",
   "devDependencies": {
-    "coffee-script": ">=1.2.0"
+    "coffee-script": ">=1.2.0",
+    "grunt": "~0.4.1",
+    "grunt-release": "~0.6.0",
+    "should": "~2.0.2",
+    "mocha": "~1.13.0",
+    "hubot": "~2.6.4",
+    "grunt-contrib-watch": "~0.5.3",
+    "grunt-shell": "~0.5.0"
   },
@@ -51,3 +58,6 @@ "main": "./src/slack",
     "node": ">=0.4.7"
+  },
+  "scripts": {
+    "test": "mocha --compilers coffee:coffee-script --reporter spec"
   }
 }

README.md

@@ -5,13 +5,31 @@ # hubot-slack
 
-## Quickstart: Hubot for Slack on Heroku
+## Getting Started
 
-First, read and understand the [instructions on the Hubot wiki](https://github.com/github/hubot/blob/master/docs/deploying/heroku.md). You will be following those instructions, with the following modifications:
+#### Creating a new bot
 
-1. Edit `package.json` and add `hubot-slack` to the `dependencies` section.
-1. Edit `Procfile` and change it to use the `slack` adapter:
+- `npm install hubot -g`
+- `hubot --create [path_name]`
+- `cd [path_name]`
+- `npm install hubot-slack --save`
+- Initialize git and make your initial commit
+- Check out the [hubot docs](https://github.com/github/hubot/tree/master/docs) for further guidance on how to build your bot
 
+#### Testing your bot locally
+
+- `./bin/hubot`
+
+#### Deploying to Heroku
+
+This is a modified set of instructions based on the [instructions on the Hubot wiki](https://github.com/github/hubot/blob/master/docs/deploying/heroku.md).
+
+- Make sure `hubot-slack` is in your `package.json` dependencies
+- Edit your `Procfile` and change it to use the `slack` adapter:
+
         web: bin/hubot --adapter slack
 
-1. Activate the Hubot service on your "Team Services" page inside Slack.
-1. Configure your Hubot install using the variables displayed on the Hubot Team Service page. Examples:
+- Install [heroku toolbelt](https://toolbelt.heroku.com/) if you haven't already.
+- `heroku create my-company-slackbot`
+- `heroku addons:add redistogo:nano`
+- Activate the Hubot service on your "Team Services" page inside Slack.
+- Add the [config variables](#adapter-configuration). For example:
 
@@ -23,4 +41,9 @@ % heroku config:add HEROKU_URL=http://soothing-mists-4567.herokuapp.com
 
-1. Follow the rest of the Hubot instructions to get up-and-running.
+- Deploy and start the bot:
 
+        % git push heroku master
+        % heroku ps:scale web=1
+
+- Profit!
+
 ## Adapter configuration
@@ -30,12 +53,12 @@
 
-### HUBOT\_SLACK\_TOKEN
+#### HUBOT\_SLACK\_TOKEN
 
 This is the service token you are given when you add Hubot to your Team Services.
 
-### HUBOT\_SLACK\_TEAM
+#### HUBOT\_SLACK\_TEAM
 
 This is your team's Slack subdomain. For example, if your team is `https://myteam.slack.com/`, you would enter `myteam` here.
 
-### HUBOT\_SLACK\_BOTNAME
+#### HUBOT\_SLACK\_BOTNAME
 
 Optional. What your Hubot is called on Slack. If you entered `slackbot` here, you would address your bot like `slackbot: help`. Otherwise, defaults to `hubot`.

No alert changes

Improved metrics

Total package byte prevSize

15423

increased by83.91%

Number of package files

8

increased by60%

Number of lines in readme file

62

increased by58.97%

Worsened metrics

Dev dependency count

8

increased by700%

No dependency changes