Skip to content

Commit 377f154

Browse files
author
Morgan Roderick
committed
Remove jQuery plugin details from README.md
1 parent 0176d1a commit 377f154

File tree

1 file changed

+0
-39
lines changed

1 file changed

+0
-39
lines changed

README.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -173,45 +173,6 @@ Setting immediate exceptions in development is easy, just tell PubSubJS about it
173173
PubSub.immediateExceptions = true;
174174
```
175175

176-
## Plugin for jQuery
177-
178-
By default PubSubJS can be used in any browser or CommonJS environment, including [node](http://nodejs.org). Additionally, PubSubJS can be built specifically for jQuery using Rake.
179-
180-
$ rake jquery
181-
182-
or using Grunt
183-
184-
$ grunt jquery
185-
186-
Produces jquery.pubsub.js
187-
188-
### Use with jQuery
189-
190-
```javascript
191-
var topic = 'greeting',
192-
data = 'world',
193-
subscriber = function sayHello( data ){
194-
console.log( 'hello ' + data );
195-
};
196-
197-
// add a subscription
198-
var token = $.pubsub('subscribe', topic, subscriber );
199-
200-
// unsubscribing
201-
$.pubsub('unsubscribe', token); // remove a specific subscription
202-
$.pubsub('unsubscribe', subscriber); // remove all subscriptions for subscriber
203-
204-
// publishing a topic
205-
$.pubsub('publish', topic, data);
206-
207-
// publishing topic syncronously
208-
$.pubsub('publishSync', topic, data);
209-
```
210-
211-
In the jQuery build, the global ```PubSub``` global is still available, so you can mix and match both ```Pubsub``` and ```$.pubsub``` as needed.
212-
213-
There is also an article about [Using PubSubJS with jQuery](http://roderick.dk/resources/using-pubsubjs-with-jquery/)
214-
215176
## Contributing to PubSubJS
216177

217178
Please see [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)