Merge pull request #97 from Intrepidd/master

Add README changes for pull request #90
2013-11-20 12:42:04 -08:00 · 2013-11-20 12:42:04 -08:00 · 569b017d9f
parent 1c6a6367e0 a9342841fa
commit 569b017d9f
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -69,6 +69,15 @@ job.may_run?  # => false
 job.run       # => false
 ```

+When firing an event, you can pass a block to the method, it will be called only if
+the transition succeeds :
+
+```ruby
+  job.run do
+    job.user.notify_job_ran # Will be called if job.may_run? is true
+  end
+```
+
 ### Callbacks

 You can define a number of callbacks for your transitions. These methods will be