diff --git a/README.md b/README.md index aa98017..8541dbc 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Table of contents: + [License](#license) -

Feature overview

+

Features

At its core it offers the following: @@ -42,7 +42,7 @@ sending messages to your listeners using one of Mbassador's publication methods -

Usage

+

Usage

Listener definition (in any bean): // every event of type TestEvent or any subtype will be delivered @@ -89,7 +89,7 @@ Message publication: bus.publish(subEvent); // will return after each handler has been invoked bus.post(subEvent).now(); // same as above -

Installation

+

Installation

This project contains a maven repository that will allow you to import MBassador as a dependency into your maven project. Currently this is all that will be provided because publishing to a central repository requires extra project setup that will be done as soon as enough people use this component. Until then, the following steps are necessary: @@ -116,7 +116,7 @@ will be done as soon as enough people use this component. Until then, the follow Of course you can always clone the repository and build from source -

Feature Roadmap

+

Roadmap

+ Make MBassador available in one of the official maven repositories as soon as the user base is big enough + Spring integration with support for conditional message dispatch in transactional context (dispatch only after successful commit etc.) -> coming in december 2012 @@ -124,13 +124,13 @@ successful commit etc.) -> coming in december 2012 during the running dispatch -

Credits

+

Credits

The initial inspiration for creating this component came from looking at Google Guava's event bus implementation. Since it did not provide all the features we needed in our project, I decided to create my own implementation. When I saw that it outperformed the Guava implementation by far, I decided to share it with the community (I was longing to give something back to the community for quite a while). -

License

+

License

This project is distributed under the terms of the MIT License. See file "LICENSE" for further reference.