Skip to content
Browse files

Minor README update

  • Loading branch information...
1 parent afd70c0 commit c7a4185ce259040340db7372e4a122c8d1155ff7 @tombell tombell committed Jun 12, 2012
Showing with 28 additions and 20 deletions.
  1. +28 −20 README.md
View
48 README.md
@@ -1,7 +1,13 @@
# hubot-scripts
-These are a collection of community scripts for
-[Hubot](https://github.com/github/hubot), a chat bot for your company.
+These are a collection of community scripts for [hubot][hubot], a chat bot for
+your company.
+
+
+## Discovering
+
+Check out the [hubot-script-catalog][script-catalog] for a list and description
+of all the available scripts.
## Installing
@@ -16,23 +22,21 @@ top of the script.
Restart your robot, and you're good to go.
-All the scripts in this repository are located in
-[`src/scripts`](https://github.com/github/hubot-scripts/tree/master/src/scripts).
+All the scripts in this repository are located in [`src/scripts`][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.
+[existing script][example-script] 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/tests.coffee)
-for your script; no one likes untested code. It makes Hubot sad.
+You'll also want to [add tests][hubot-script-tests] 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.
+Additionally, it's extremely helpful to add [TomDoc][tomdoc] to the top of each
+file. (Check out [an example][example-script-doc]). We'll pull out the commands
+from those lines and display them in the generic, robot-wide `hubot help`
+command.
Please note we're no longer including external dependencies in the
`package.json`, so should you wish to include them please include the package
@@ -65,10 +69,14 @@ header so people know every thing about the script.
```
If you have nothing to fill in for a section you should include `None` in that
-section. A script will be required to fill out the documentation before being
-merged into the repository.
-
-## Discovering
-
-[The Script Catalog](http://hubot-script-catalog.herokuapp.com/)
-
+section. Empty sections which are optional should be left blank. A script will
+be required to fill out the documentation before being merged into the
+repository.
+
+[hubot]: https://github.com/github/hubot
+[script-catalog]: http://hubot-script-catalog.herokuapp.com
+[src-scripts]: https://github.com/github/hubot-scripts/tree/master/src/scripts
+[tomdoc]: http://tomdoc.org
+[example-script]: https://github.com/github/hubot-scripts/blob/master/src/scripts/tweet.coffee
+[hubot-script-tests]: https://github.com/github/hubot-scripts/blob/master/test/tests.coffee
+[example-script-docs]: (https://github.com/github/hubot-scripts/blob/master/src/scripts/speak.coffee#L1-5

0 comments on commit c7a4185

Please sign in to comment.
Something went wrong with that request. Please try again.