hubot-hall-scripts

This is a collection of scripts for hubot, a chat bot for your company. These scripts works on Hall (www.hall.com)

Discovering

• hall-sound-me : post a sound message on Hall's room.
• irb : run a snippet of code on your message.

Installing

Once you have Hubot installed, you should put on package.json the hubot-scripts.json to list any scripts from this repository you want to load.

The default hubot-hall-scripts.json looks like:

["hall-sound-me.coffee","irb.coffee"]

If you update hubot-hall-scripts in package.json, you will automatically get updates to your scripts listed here.

Alternatively, you can copy files from this repository into your scripts directory. Note that you would not get updates from the hubot-hall-scripts repository unless you copy them yourself.

Any third-party dependencies for scripts need the addition of your package.json otherwise a lot of errors will be thrown during the start up of your hubot. You can find a list of dependencies for a script in the documentation header at the top of the script.

Documentation

All scripts in hubot-hall-scripts contain a documentation header so people know every thing about the script.

# Description
#   <description of the scripts functionality>
#
# Dependencies:
#   "<module name>": "<module version>"
#
# Configuration:
#   LIST_OF_ENV_VARS_TO_SET
#
# Commands:
#   hubot <trigger> - <what the respond trigger does>
#   <trigger> - <what the hear trigger does>
#
# Notes:
#   <optional notes required for the script>
#
# Author:
#   <github username of the original script author>