Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

hubot-scripts readme should be about scripts

  • Loading branch information...
commit 0604c5dbc203204c97a7dda90ae25164f7afc53e 1 parent 7d63fc2
@holman holman authored
Showing with 22 additions and 8 deletions.
  1. +22 −8 README.md
View
30 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.
Please sign in to comment.
Something went wrong with that request. Please try again.