hubot-response - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

examples/extension.js

 // Import the module you want
-var config = require('hubot-response-applause').applause
+var config = require('hubot-response-success');
 
 // Extend whatever you wany
-config.response.push('applause!');
+config.response.push('success!');
 
 // Export the altered object
 module.exports = config;

examples/hello-world.json

 {
   "match": "Hello",
+  "description": "hello - finish hello world!",
   "listener": "hear",
@@ -4,0 +5,0 @@ "response": [

external-scripts.json

 [
-  "hubot-response"
+  "hubot-response",
+  "hubot-help"
 ]

package.json

 {
   "name": "hubot-response",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "index.coffee",
@@ -18,3 +18,4 @@ "description": "Makes creating hubot responses easy.",
     "coffee-script": "^1.9.0",
-    "glob": "^5.0.14"
+    "glob": "^5.0.14",
+    "hubot-response-success": "^1.0.0"
   },
@@ -24,2 +25,3 @@ "devDependencies": {
     "hubot": "^2.16.0",
+    "hubot-help": "^0.1.1",
     "hubot-response-applause": "^1.0.1",
@@ -26,0 +28,0 @@ "mocha": "^2.0.0",

README.md

@@ -8,2 +8,3 @@ ## Hubot Response
   "match": "Hello",
+  "description": "hello - finish hello world!",
   "listener": "hear",
@@ -39,2 +40,3 @@ "response": [
   "match": "Hello",
+  "description": "hello - finish hello world!",
   "listener": "hear",
@@ -61,5 +63,18 @@ "response": [
 - `match` - Either a string that is turned into a regex, or an actual instance of `RegExp` that the robot is listening for.
+- `description` - Entry for hubot commands. Use this to display with `hubot-help`. See [Commands](https://github.com/github/hubot/blob/master/docs/scripting.md#documenting-scripts) for formatting.
 - `listener` - Either [`hear` or `respond`](https://github.com/github/hubot/blob/master/docs/scripting.md#hearing-and-responding).
 - `response` - Can be a `String`, `Function` that is called, or an `Array` where an index is randomly selected.
 
+## Try before you buy
+Clone this locally and run
+
+```
+npm install
+npm start
+```
+
+This will run a local hubot-shell. You can interact with the [examples](examples/).
+
+**Protip**: Run `hubot-help` for a list of available commands.
+
 ## Don't we already have [a way of doing this](https://github.com/hubot-scripts)?
@@ -66,0 +81,0 @@ Yes, and the [hubot-scripts](https://github.com/hubot-scripts) org is awesome! But for simple hear and respond modules (animated gifs mostly) customization sucks...

No alert changes

Improved metrics

Total package byte prevSize

7856

17.1%

Lines of code

22

10%

Number of lines in readme file

92

19.48%

Worsened metrics

Dependency count

3

50%

Dev dependency count

7

16.67%

Dependency changes

• + Added

  hubot-response-success@^1.0.0

• + Added

  hubot-response-success@1.0.2
  (transitive)