README.md in simpler_workflow-0.3.0.beta vs README.md in simpler_workflow-0.3.0.beta2

- old
+ new

@@ -1,8 +1,9 @@ # SimplerWorkflow [![Build Status](https://secure.travis-ci.org/fredjean/simpler_workflow.png)](http://travis-ci.org/fredjean/simpler_workflow) +[![Code Climate](https://codeclimate.com/github/fredjean/simpler_workflow.png)](https://codeclimate.com/github/fredjean/simpler_workflow) A wrapper around Amazon's Simple Workflow Service meant to simplify declaring and using activities and workflow. Provides some sane defaults and work around some idiosyncracies of the platform. ## Installation @@ -173,9 +174,19 @@ You can also define similar hooks for events using the following methods: * ```on_activity_completed``` is called when an activity completes and SWF reports back to the decision loop. * ```on_activity_failed``` is called when an activity reports a failure to SWF. + +### Triggering Workflows + +You can trigger the worklow with the following command: + +```ruby +SimplerWorkflow::Domain["my-test-domain"].start_workflow("hello-world", "1.0.1", "AWS") +``` + +The parameters are the name of the workflow, the version as well as a string representing the input to the workflow. ## Workflow and Activity Versioning All workflow types and activity types are versioned under SWF. This allows an organization to release new versions of a workflow or activity as they are updated and allow workflows to complete under the old version number if need be.