Skip to content

Commit

Permalink
[minor] Documentation on events emitted by instances of broadway.App()
Browse files Browse the repository at this point in the history
  • Loading branch information
jfhbrook committed Nov 10, 2011
1 parent 000c5c4 commit dafd98c
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Expand Up @@ -26,7 +26,6 @@ app.hello("world");
### plugins/helloworld.js

```js

// `exports.attach` gets called by broadway on `app.use`
exports.attach = function (options) {

Expand Down Expand Up @@ -101,7 +100,14 @@ var plugin = {

### App#on(event, callback) and App#emit(event, data)

See [EventEmitter2][2] documentation for more information.
App inherits from [EventEmitter2][2], and many plugins build on this
functionality.

#### Built-In Events:

* `error:init`: Broadway emits this event when it throws an error while attempting to initialize.

Read the [EventEmitter2][2] documentation for more information.

## Tests
All tests are written with [vows][0] and should be run with [npm][1]:
Expand Down

0 comments on commit dafd98c

Please sign in to comment.