How to set environment variables will be specific to your operating system.
	 Rather than recreate the various methods and best practices in achieving this,
	 it's suggested that you search for a dedicated guide focused on your OS.

	 An example script is included at `scripts/example.coffee`, so check it out to
	 get started, along with the [Scripting Guide][scripting-docs].

	 For many common tasks, there's a good chance someone has already one to do just
	 the thing.

	 [scripting-docs]: https://github.com/github/hubot/blob/master/docs/scripting.md

	 There will inevitably be functionality that everyone will want. Instead of
	 writing it yourself, you can use existing plugins.

	 Hubot is able to load plugins from third-party `npm` packages. This is the
	 recommended way to add functionality to your hubot. You can get a list of
	 available hubot plugins on [npmjs.com][npmjs] or by using `npm search`:

	 % npm search hubot-scripts panda
	 NAME             DESCRIPTION                        AUTHOR DATE       VERSION KEYWORDS
	 hubot-pandapanda a hubot script for panda responses =missu 2014-11-30 0.9.2   hubot hubot-scripts panda
	 ...


	 To use a package, check the package's documentation, but in general it is:

	 1. Use `npm install --save` to add the package to `package.json` and install it
	 2. Add the package name to `external-scripts.json` as a double quoted string

	 You can review `external-scripts.json` to see what is included by default.

	 It is also possible to define `external-scripts.json` as an object to
	 explicitly specify which scripts from a package should be included. The example
	 below, for example, will only activate two of the six available scripts inside
	 the `hubot-fun` plugin, but all four of those in `hubot-auto-deploy`.

	 ```json

**Be aware that not all plugins support this usage and will typically fallback
to including all scripts.**

[npmjs]: https://www.npmjs.com

### hubot-scripts

Before hubot plugin packages were adopted, most plugins were held in the
[hubot-scripts][hubot-scripts] package. Some of these plugins have yet to be
migrated to their own packages. They can still be used but the setup is a bit
different.

To enable scripts from the hubot-scripts package, add the script name with
extension as a double quoted string to the `hubot-scripts.json` file in this
repo.

[hubot-scripts]: https://github.com/github/hubot-scripts

##  Persistence

If you are going to use the `hubot-redis-brain` package (strongly suggested),
   you will need to add the Redis to Go addon on Heroku which requires a verified
   account or you can create an account at [Redis to Go][redistogo] and manually
   set the `REDISTOGO_URL` variable.

   % heroku config:add REDISTOGO_URL="..."

   If you don't need any persistence feel free to remove the `hubot-redis-brain`
   from `external-scripts.json` and you don't need to worry about redis at all.

   [redistogo]: https://redistogo.com/

## Adapters

   Adapters are the interface to the service you want your hubot to run on, such
   as Campfire or IRC. There are a number of third party adapters that the
   community have contributed. Check [Hubot Adapters][hubot-adapters] for the
   available ones.

   If you would like to run a non-Campfire or shell adapter you will need to add
   the adapter package as a dependency to the `package.json` file in the
   `dependencies` section.

   Once you've added the dependency with `npm install --save` to install it you
   can then run hubot with the adapter.

   % bin/hubot -a <adapter>

   Where `<adapter>` is the name of your adapter without the `hubot-` prefix.

   [hubot-adapters]: https://github.com/github/hubot/blob/master/docs/adapters.md

## Deployment

   % heroku create --stack cedar
   % git push heroku master

   If your Heroku account has been verified you can run the following to enable
   and add the Redis to Go addon to your app.

   % heroku addons:add redistogo:nano

   If you run into any problems, checkout Heroku's [docs][heroku-node-docs].

   You'll need to edit the `Procfile` to set the name of your hubot.

   More detailed documentation can be found on the [deploying hubot onto
   Heroku][deploy-heroku] wiki page.

### Deploying to UNIX or Windows

   If you would like to deploy to either a UNIX operating system or Windows.
   Please check out the [deploying hubot onto UNIX][deploy-unix] and [deploying
   hubot onto Windows][deploy-windows] wiki pages.

   [heroku-node-docs]: http://devcenter.heroku.com/articles/node-js
   [deploy-heroku]: https://github.com/github/hubot/blob/master/docs/deploying/heroku.md
   [deploy-unix]: https://github.com/github/hubot/blob/master/docs/deploying/unix.md
   [deploy-windows]: https://github.com/github/hubot/blob/master/docs/deploying/windows.md

## Campfire Variables

   If you are using the Campfire adapter you will need to set some environment
   variables. If not, refer to your adapter documentation for how to configure it,
   links to the adapters can be found on [Hubot Adapters][hubot-adapters].

   Create a separate Campfire user for your bot and get their token from the web
   UI.

   % heroku config:add HUBOT_CAMPFIRE_TOKEN="..."

   Get the numeric IDs of the rooms you want the bot to join, comma delimited. If
   you want the bot to connect to `https://mysubdomain.campfirenow.com/room/42`
   and `https://mysubdomain.campfirenow.com/room/1024` then you'd add it like
   this:

   % heroku config:add HUBOT_CAMPFIRE_ROOMS="42,1024"

   Add the subdomain hubot should connect to. If you web URL looks like
   `http://mysubdomain.campfirenow.com` then you'd add it like this:

   % heroku config:add HUBOT_CAMPFIRE_ACCOUNT="mysubdomain"

   [hubot-adapters]: https://github.com/github/hubot/blob/master/docs/adapters.md

## Restart the bot

   You may want to get comfortable with `heroku logs` and `heroku restart` if
   you're having issues.