Skip to content
Newer
Older
100644 39 lines (26 sloc) 1.59 KB
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
1 # hubot-scripts
950a394 @atmos add speak as the first example
atmos authored
2
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
3 These are a collection of community scripts for
4 [Hubot](https://github.com/github/hubot), a chat bot for your company.
950a394 @atmos add speak as the first example
atmos authored
5
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
6 ## Installing
950a394 @atmos add speak as the first example
atmos authored
7
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
8 Once you have Hubot installed, you can drop new scripts from this repository
c7c927e @tombell Add notice about dependencies
tombell authored
9 right into your generated Hubot installation. Just put them in `scripts`, add
10 the new scripts to the `hubot-scripts.json` file, restart your robot, and
11 you're good to go.
950a394 @atmos add speak as the first example
atmos authored
12
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
13 All the scripts in this repository are located in
14 [`src/scripts`](https://github.com/github/hubot-scripts/tree/master/src/scripts).
950a394 @atmos add speak as the first example
atmos authored
15
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
16 ## Writing
950a394 @atmos add speak as the first example
atmos authored
17
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
18 Want to write your own Hubot script? The best way is to take a look at an
19 [existing script](https://github.com/github/hubot-scripts/blob/master/src/scripts/tweet.coffee)
20 and see how things are set up. Hubot scripts are written in CoffeeScript, a
21 higher-level implementation of JavaScript.
22
bd44f1f @sferik Fix link to tests.
sferik authored
23 You'll also want to [add tests](https://github.com/github/hubot-scripts/blob/master/test/tests.coffee)
0604c5d @holman hubot-scripts readme should be about scripts
holman authored
24 for your script; no one likes untested code. It makes Hubot sad.
25
26 Additionally, it's extremely helpful to add [TomDoc](http://tomdoc.org) to the
27 top of each file. (Check out [an example](https://github.com/github/hubot-scripts/blob/master/src/scripts/speak.coffee#L1-5)).
28 We'll pull out the commands from those lines and display them in the generic,
29 robot-wide `hubot help` command.
edebd3e @markomanninen spin.coffee header and description added on read me file
markomanninen authored
30
c7c927e @tombell Add notice about dependencies
tombell authored
31 Please note we're no longer including external dependencies in the
32 `package.json`, so should you wish to include them please include the package
33 name and required version in the TomDoc comments at the top of your script.
34
d3a644a @atmos make the readme applicable to the project
atmos authored
35 ## Discovering
edebd3e @markomanninen spin.coffee header and description added on read me file
markomanninen authored
36
3c7d23d @atmos readme link is not an image
atmos authored
37 [The Script Catalog](http://hubot-script-catalog.herokuapp.com/)
3b98032 @markomanninen script commands added to readme
markomanninen authored
38
Something went wrong with that request. Please try again.