Skip to content

Commit

Permalink
hubot-scripts readme should be about scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
holman committed Sep 27, 2011
1 parent 7d63fc2 commit 0604c5d
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
@@ -1,14 +1,28 @@
Hubot Speaks!
=============
# hubot-scripts

Use Microsoft's Language Translation API to link to wav files of
sentences.
These are a collection of community scripts for
[Hubot](https://github.com/github/hubot), a chat bot for your company.

http://www.microsofttranslator.com/dev/
## Installing

Installing
==========
Once you have Hubot installed, you can drop new scripts from this repository
right into your generated Hubot installation. Just put them in `scripts`,
restart your robot, and you're good to go.

Add `hubot-speak` to your hubot installation
All the scripts in this repository are located in
[`src/scripts`](https://github.com/github/hubot-scripts/tree/master/src/scripts).

## Writing

Want to write your own Hubot script? The best way is to take a look at an
[existing script](https://github.com/github/hubot-scripts/blob/master/src/scripts/tweet.coffee)
and see how things are set up. Hubot scripts are written in CoffeeScript, a
higher-level implementation of JavaScript.

You'll also want to [add tests](https://github.com/github/hubot-scripts/blob/master/test/scripts/test.coffee)
for your script; no one likes untested code. It makes Hubot sad.

Additionally, it's extremely helpful to add [TomDoc](http://tomdoc.org) to the
top of each file. (Check out [an example](https://github.com/github/hubot-scripts/blob/master/src/scripts/speak.coffee#L1-5)).
We'll pull out the commands from those lines and display them in the generic,
robot-wide `hubot help` command.

0 comments on commit 0604c5d

Please sign in to comment.