diff --git a/README.md b/README.md index 8f5f324..4de8283 100644 --- a/README.md +++ b/README.md @@ -19,18 +19,31 @@ You will need to set some environment variables to use this adapter. ### Heroku % heroku config:add HUBOT_IRC_NICK="hubot" - % heroku config:add HUBOT_IRC_ROOMS="#hubot,#hubot-irc" - % heroku config:add HUBOT_IRC_SERVER="irc.freenode.net" ### Non-Heroku environment variables % export HUBOT_IRC_NICK="hubot" - % export HUBOT_IRC_ROOMS="#hubot,#hubot-irc" - % export HUBOT_IRC_SERVER="irc.freenode.net" + +### Testing Local Changes + + gem install foreman + git clone https://github.com/github/hubot.git + cd hubot + # this next line makes a deployable version of the bot for heroku or local deployments + make package + mv hubot/ ../testbot + cd ../testbot + - modify package.json to include the version of hubot-irc to test with either an official release or from your local repo + for an example see this https://gist.github.com/3148311 + - modify Procfile, change adapter (-a option) to "irc" and change the name (-n option) of the bot + - make sure you followed the usage section from above to set the environment variables (Non-Heroku section) + foreman start + + ...and that is it ## Contribute