Readme

README.md

@@ -1,7 +1,7 @@
 Kaliop eZWorkflowEngine Bundle
 ==============================
 
-A workflow engine for eZPublish5 / eZPlatform.
+A workflow engine for eZPublish5 / eZPlatform 1 and 2.
 
 
 ## How it works, in 10 lines of configuration
@@ -31,13 +31,13 @@ More examples of how "real-life" workflows do look like:
 
 ## Getting started
 
-1. Install the bundle using composer, enable `EzWorkflowEngineBundle` in your application Kernel (if you had not previously
-    installed the eZMigrationBundle, you should enable as well `EzMigrationBundle` - composer will have downloaded it
+1. Install the bundle using Composer, enable `EzWorkflowEngineBundle` in your application Kernel (if you had not previously
+    installed the eZMigrationBundle, you should enable as well `EzMigrationBundle` - Composer will have downloaded it
     automatically for you, but not enabled it)
 
 2. Create a workflow definition in any bundle you want by using the dedicated command
 
-        php ezpublish/console kaliop:workflows:generate myBundle
+        php bin/console kaliop:workflows:generate myBundle
 
 3. Edit the workflow definition
 
@@ -46,25 +46,25 @@ More examples of how "real-life" workflows do look like:
 
 4. test that the workflow is listed as available
 
-        php ezpublish/console kaliop:workflows:debug
+        php bin/console kaliop:workflows:debug
 
 5. connect to the Administration Interface, execute the desired content modification action.
     (Note: if you are using the Legacy Admin interface, you will need to execute extra work. Read the dedicated chapter below)
 
 6. check that the workflow you defined did execute
 
-        php ezpublish/console kaliop:workflows:status
+        php bin/console kaliop:workflows:status
 
     Also, if you have enabled 'debug' level logging for Symfony, you will find that any time an eZPublish signal is
     emitted, the workflow engine add to the log 1 or 2 lines with information about its actions.
 
 7. set up a cron job that will pick up and restart any suspended workflow by executing, fe. every 5 minutes, the following:
 
-        php ezpublish/console kaliop:workflows:resume -n
+        php bin/console kaliop:workflows:resume -n
 
 8. set up a cron job that will clean up the workflow table in the database by executing, fe. daily, the following:
 
-        php ezpublish/console kaliop:workflows:cleanup
+        php bin/console kaliop:workflows:cleanup
 
 9. once your workflow is debugged and tested, don't forget to commit the workflow definition file as part of your source code ;-)
 
@@ -118,11 +118,12 @@ A: yes, just as you would with a migration (see the doc in the migrationbundle f
 
 Q: does the workflow engine emit Symfony Events when workflows are run?
 
-A: yes. Currently the following events are emitted:
-    * ez_workflow.before_execution
-    * ez_workflow.step_executed
-    * ez_workflow.workflow_aborted
-    * ez_workflow.workflow_suspended
+A: yes. Currently, the following events are emitted:
+
+  * ez_workflow.before_execution
+  * ez_workflow.step_executed
+  * ez_workflow.workflow_aborted
+  * ez_workflow.workflow_suspended
 
 Q: can the workflow engine be used for scenarios where user interaction is required (eg. Content Approval ?)