README.md in clomp-0.1.0 vs README.md in clomp-1.0.0
- old
+ new
@@ -23,11 +23,18 @@
## Usage
Build any service with the track! Add as many tracks as you want.
tracks will be loaded sequentially. You can control success and failure state of any
specific step.
+### Example application
+You may check the following rails project for basic understanding.
+[Clomp Usage Example](https://github.com/rubyrider/clomp-example)
+Clomp is completely framework independent agnostic framework. You can use it with any ruby frameworks
+and even with your raw ruby code.
+
+
Consider the following class:
```ruby
class AnotherOperation < Clomp::Operation
track :track_from_another_operation
@@ -35,16 +42,9 @@
options[:hello_from_another_operation] = true
end
end
class SingingOperation < Clomp::Operation
- # Configure your operation for common tracks,
- # configuration can be overridden from individual tracks
- setup do |config|
- config.fail_fast = true
- config.optional = true
- end
-
# this block only executes on failure step!
# pass options to receive the operation states!
add_track :get_lyrics do |options|
# we call this a failure state based block!
options[:do_some_thing] = 10