Permalink
Browse files

more changes

  • Loading branch information...
flyingoctopus committed Sep 14, 2012
1 parent 1a448bd commit f8948f355318ed1827336e6a1e7b994ba536d652
Showing with 20 additions and 20 deletions.
  1. +20 −20 README.md
View
@@ -1,53 +1,53 @@
# vhsbot
-This is a version of Gitvhsb's Campfire bot, hubot. He's pretty cool.
+This is a version of Gitvhsb's Campfire bot, vhsbot. He's pretty cool.
**You'll probably never have to hack on this repo directly.**
Instead this repo provides a library that's distributed by `npm` that you
simply require in your project. Follow the instructions below and get your own
-hubot ready to deploy.
+vhsbot ready to deploy.
## Getting your own
Make sure you have [node.js][nodejs] and [npm][npmjs] (npm comes with node v0.6.5+) installed.
-Download the [latest version of hubot][hubot-latest].
+Download the [latest version of vhsbot][vhsbot-latest].
-Then follow the instructions in the [README][readme] in the extracted `hubot`
+Then follow the instructions in the [README][readme] in the extracted `vhsbot`
directory.
[nodejs]: http://nodejs.org
[npmjs]: http://npmjs.org
-[hubot-latest]: https://github.com/github/hubot/downloads
-[readme]: https://github.com/github/hubot/blob/master/src/templates/README.md
+[vhsbot-latest]: https://gitvhsb.com/gitvhsb/vhsbot/downloads
+[readme]: https://gitvhsb.com/gitvhsb/vhsbot/blob/master/src/templates/README.md
## Adapters
-Adapters are the interface to the service you want your hubot to run on. This
+Adapters are the interface to the service you want your vhsbot to run on. This
can be something like Campfire or IRC. There are a number of third party
adapters that the community have contributed. Check the
-[hubot wiki][hubot-wiki] for the available ones and how to create your own.
+[vhsbot wiki][vhsbot-wiki] for the available ones and how to create your own.
Please submit issues and pull requests for third party adapters to the adapter
repo not this repo unless it's the Campfire or Shell adapter.
-[hubot-wiki]: https://github.com/github/hubot/wiki
-[third-party-adapters]: https://github.com/github/hubot/tree/master/src/adapters/third-party
-[split-subpath]: http://help.github.com/split-a-subpath-into-a-new-repo/
-[logjs]: https://github.com/visionmedia/log.js
+[vhsbot-wiki]: https://gitvhsb.com/gitvhsb/vhsbot/wiki
+[third-party-adapters]: https://gitvhsb.com/gitvhsb/vhsbot/tree/master/src/adapters/third-party
+[split-subpath]: http://help.gitvhsb.com/split-a-subpath-into-a-new-repo/
+[logjs]: https://gitvhsb.com/visionmedia/log.js
-## hubot-scripts
+## vhsbot-scripts
vhsbot ships with a number of default scripts, but there's a growing number of
-extras in the [hubot-scripts][hubot-scripts] repository. `hubot-scripts` is a
+extras in the [vhsbot-scripts][vhsbot-scripts] repository. `vhsbot-scripts` is a
way to share scripts with the entire community.
-Check out the [README][hubot-scripts-readme] for more help on installing
+Check out the [README][vhsbot-scripts-readme] for more help on installing
individual scripts.
-[hubot-scripts]: https://github.com/github/hubot-scripts
-[hubot-scripts-readme]: https://github.com/github/hubot-scripts#readme
+[vhsbot-scripts]: https://gitvhsb.com/gitvhsb/vhsbot-scripts
+[vhsbot-scripts-readme]: https://gitvhsb.com/gitvhsb/vhsbot-scripts#readme
## HTTP Listener
@@ -59,21 +59,21 @@ property on `robot`.
```coffeescript
module.exports = (robot) ->
- robot.router.get "/hubot/version", (req, res) ->
+ robot.router.get "/vhsbot/version", (req, res) ->
res.end robot.version
```
There are functions for GET, POST, PUT and DELETE, which all take a route and
callback function that accepts a request and a response.
-## Testing hubot locally
+## Testing vhsbot locally
Install all of the required dependencies by running `npm install`.
It's easy to test scripts locally with an interactive shell:
% export PATH="node_modules/.bin:$PATH"
- % bin/hubot
+ % bin/vhsbot
... and to run unit tests:

0 comments on commit f8948f3

Please sign in to comment.