Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updating markdown

  • Loading branch information...
commit 8f25ec65b42fda2248c97bb0a45d06f2536b4994 1 parent 180d2b4
Eric Feminella authored
Showing with 3 additions and 3 deletions.
  1. +3 −3 README.md
6 README.md
View
@@ -1,7 +1,7 @@
-##EventBroker API##
+##EventBroker API
Provides a general purpose Event Broker implementation to Backbone based on the Backbone Events API. The EventBroker can be used directly to serve as a centralized event management mechanism for an entire application. Additional, context specific, namespaced brokers can also be created in order to provide unique brokers within a particular part of an application.
-###Basic Usage###
+###Basic Usage
The `EventBroker` can be used directly to publish and subscribe to events of interest:
``` javascript
var Users = Backbone.Collection.extend{{
@@ -30,7 +30,7 @@ var UserEditor = Backbone.View.extend({
```
-###Creating namespaced EventBrokers###
+###Creating namespaced EventBrokers
The `EventBroker` API can be used to create and retrieve any number of specific namespaced `EventBrokers`. A namespaced `EventBroker` ensures that all events are published and subscribed against a specific namespace.
Namespaced `EventBrokers` are retrieved via `Backbone.EventBroker.get(<i>namespace</i>)`. If an `EventBroker` has not been created for the given namespace, it will be created and returned. All subsequent retrievals will return the same `EventBroker` instance for the specified namespace; i.e. only one unique `EventBroker` is created per namespace.
Please sign in to comment.
Something went wrong with that request. Please try again.