Prepped for v0.9.0 release candidate 1

This commit is contained in:
ifandelse 2014-02-11 14:41:38 -05:00
parent ba9b3bf1ca
commit 86570ea701
10 changed files with 14 additions and 14 deletions

View file

@ -1,6 +1,7 @@
# Postal.js
## Version 0.8.11 (Dual Licensed [MIT](http://www.opensource.org/licenses/mit-license) & [GPL](http://www.opensource.org/licenses/gpl-license))
## Version 0.9.0-rc1 (Dual Licensed [MIT](http://www.opensource.org/licenses/mit-license) & [GPL](http://www.opensource.org/licenses/gpl-license))
*(Note: this is the first release candidate for v0.9.0)*
## What is it?
Postal.js is an in-memory message bus - very loosely inspired by [AMQP](http://www.amqp.org/) - written in JavaScript. Postal.js runs in the browser, or on the server-side using Node.js. It takes the familiar "eventing-style" paradigm (of which most JavaScript developers are familiar) and extends it by providing "broker" and subscriber implementations which are more sophisticated than what you typically find in simple event delegation.
@ -118,14 +119,13 @@ dupSubscription.unsubscribe();
```
## More References
Please visit the [postal.js wiki](https://github.com/postaljs/postal.js/wiki) for API documentation, discussion of concepts and links to blogs/articles on postal.js.
Please visit the [postal.js wiki](https://github.com/postaljs/postal.js/wiki) for API documentation, discussion of concepts and links to blogs/articles on postal.js. Just bear in mind that the wiki won't be updated for v0.9.0 until a release is final.
## How can I extend it?
There are four main ways you can extend Postal:
* Write a plugin. Need more complex behavior that the built-in SubscriptionDefinition doesn't offer? Write a plugin that you can attach to the global postal object. See [postal.when](https://github.com/postaljs/postal.when) for an example of how to do this.
* Write a custom federation plugin, to federate instances of postal across a transport of your choice.
* You can write an entirely new bus implementation if you wanted. The postal `subscribe`, `publish` and `addWiretap` calls all simply wrap a concrete implementation provided by the `postal.configuration.bus` object. For example, if you wanted a bus that stored message history in local storage and pushed a dump of past messages to a new subscriber, you'd simply write your implementation and then swap the default one out by calling: `postal.configuration.bus = myWayBetterBusImplementation`.
* You can also change how the `bindingResolver` matches subscriptions to message topics being published. You may not care for the AMQP-style bindings functionality. No problem! Write your own resolver object that implements a `compare` and `reset` method and swap the core version out with your implementation by calling: `postal.configuration.resolver = myWayBetterResolver`.
It's also possible to extend the monitoring of messages passing through Postal by adding a "wire tap". A wire tap is a callback that will get invoked for any published message (even if no actual subscriptions would bind to the message's topic). Wire taps should _not_ be used in lieu of an actual subscription - but instead should be used for diagnostics, logging, forwarding (to a websocket publisher or a local storage wrapper, for example) or other concerns that fall along those lines. This repository used to include a console logging wiretap called postal.diagnostics.js - you can now find it [here in it's own repo](https://github.com/postaljs/postal.diagnostics). This diagnostics wiretap can be configured with filters to limit the firehose of message data to specific channels/topics and more.
@ -152,5 +152,5 @@ Here's where Postal is headed:
* Add-ons to enable message capture and replay are in the works and should be ready soon.
* The `SubscriptionDefinition` object will be given the ability to pause (skip) responding to subscriptions
* We'll be working on experimental "lightweight" builds of postal, providing a basic SubscriptionDefinition prototype, but removing the more advanced options if you don't need them. Reduced size builds would be offered alongside full builds, giving you page-weight-sensitive options.
* We'll be working on experimental "underscore-free" builds of postal, providing ES5 method shims so that you don't have to pull in underscore/lodash just to run postal.
* What else would you like to see?

View file

@ -1,6 +1,6 @@
{
"name": "postal.js",
"version": "0.8.11",
"version": "0.9.0-rc1",
"description": "Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.",
"homepage": "https://github.com/postaljs/postal.js",
"keywords": [

View file

@ -2,7 +2,7 @@
"name": "postal.js",
"repo": "postaljs/postal.js",
"description": "Client-side messaging library",
"version": "0.8.11",
"version": "0.9.0-rc1",
"keywords": [
"pub/sub",
"pub",
@ -21,4 +21,4 @@
},
"scripts": ["lib/postal.min.js", "lib/postal.js"],
"license": "MIT"
}
}

View file

@ -1,7 +1,7 @@
/**
* postal - Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.
* Author: Jim Cowart (http://freshbrewedcode.com/jimcowart)
* Version: v0.8.11
* Version: v0.9.0-rc1
* Url: http://github.com/postaljs/postal.js
* License(s): MIT, GPL
*/

View file

@ -1,7 +1,7 @@
/**
* postal - Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.
* Author: Jim Cowart (http://freshbrewedcode.com/jimcowart)
* Version: v0.8.11
* Version: v0.9.0-rc1
* Url: http://github.com/postaljs/postal.js
* License(s): MIT, GPL
*/

View file

@ -1,7 +1,7 @@
/**
* postal - Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.
* Author: Jim Cowart (http://freshbrewedcode.com/jimcowart)
* Version: v0.8.11
* Version: v0.9.0-rc1
* Url: http://github.com/postaljs/postal.js
* License(s): MIT, GPL
*/

2
lib/postal.min.js vendored
View file

@ -1,7 +1,7 @@
/**
* postal - Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.
* Author: Jim Cowart (http://freshbrewedcode.com/jimcowart)
* Version: v0.8.11
* Version: v0.9.0-rc1
* Url: http://github.com/postaljs/postal.js
* License(s): MIT, GPL
*/

View file

@ -1,7 +1,7 @@
/**
* postal - Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.
* Author: Jim Cowart (http://freshbrewedcode.com/jimcowart)
* Version: v0.8.11
* Version: v0.9.0-rc1
* Url: http://github.com/postaljs/postal.js
* License(s): MIT, GPL
*/

View file

@ -1,7 +1,7 @@
/**
* postal - Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.
* Author: Jim Cowart (http://freshbrewedcode.com/jimcowart)
* Version: v0.8.11
* Version: v0.9.0-rc1
* Url: http://github.com/postaljs/postal.js
* License(s): MIT, GPL
*/

View file

@ -1,7 +1,7 @@
{
"name": "postal",
"description": "Pub/Sub library providing wildcard subscriptions, complex message handling, etc. Works server and client-side.",
"version": "0.8.11",
"version": "0.9.0-rc1",
"homepage": "http://github.com/postaljs/postal.js",
"repository": {
"type": "git",