README.md in celluloid-0.0.3 vs README.md in celluloid-0.1.0
- old
+ new
@@ -11,10 +11,21 @@
also the ability to call methods _asynchronously_, allowing the receiver to do
things in the background while the caller carries on with its business.
These concurrent objects are called "actors". Actors are somewhere in between
the kind of object you're typically used to working with and a network service.
+Supported Platforms
+-------------------
+
+Celluloid works on Ruby 1.9.2, JRuby 1.6 (in 1.9 mode), and Rubinius 2.0. JRuby
+or Rubinius are the preferred platforms as they support true concurrent threads.
+
+To use JRuby in 1.9 mode, you'll need to pass the "--1.9" command line option
+to the JRuby executable, or set the "JRUBY_OPTS=--1.9" environment variable.
+
+Celluloid works on Rubinius in either 1.8 or 1.9 mode.
+
Usage
-----
To use Celluloid, define a normal Ruby class that includes Celluloid::Actor
@@ -266,21 +277,27 @@
onto a reference to a crashed copy of that actor, rather than talking to a
working, freshly-restarted version.
The main use of the registry is for interfacing with actors that are
automatically restarted by supervisors when they crash.
+
+Logging
+-------
+
+By default, Celluloid will log any errors and backtraces from any crashing
+actors to STDOUT. However, if you wish you can use any logger which is
+compatible with the standard Ruby Logger API. For example, if you're using
+Celluloid within a Rails application, you'll probably want to do:
+
+ Celluloid.logger = Rails.logger
Contributing to Celluloid
-------------------------
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Fork Celluloid on github
+* Make your changes and send me a pull request
+* If I like them I'll merge them and give you commit access to my repository
Copyright
---------
-Copyright (c) 2011 Tony Arcieri. See LICENSE.txt for further details.
\ No newline at end of file
+Copyright (c) 2011 Tony Arcieri. See LICENSE.txt for further details.