README.md in event_aggregator-0.0.1 vs README.md in event_aggregator-0.0.2
- old
+ new
@@ -1,7 +1,9 @@
# EventAggregator
+#### Note: This is a very early release and subject to many changes. It is currently not tested propperly, and there are several issues ranging from potential dead-locks to upcoming refactoring.
+
The 'event_aggregator' gem is a gem for using the event aggregator pattern in Ruby.
An event aggregator is essentially a message passing service that aims at decoupeling object communication and that lets
## Installation
@@ -26,13 +28,13 @@
require "event_aggregator"
class Foo
include EventAggregator::Listener
def initialize()
- message_type_to_recieve_add( "foo", lambda{|data| puts "bar" } )
+ message_type_to_receive_add( "foo", lambda{|data| puts "bar" } )
- message_type_to_recieve_add( "foo2", method(:handle_message) )
+ message_type_to_receive_add( "foo2", method(:handle_message) )
end
def handle_message(data)
puts data
end
@@ -55,7 +57,8 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Todo:
+ - Adding tests
- Enable threaded message passing for higher performance.
- - Improving the readme and documentation in the gem.
\ No newline at end of file
+ - Improving the readme and documentation in the gem.