README.mdown in cukeforker-0.1.4 vs README.mdown in cukeforker-0.1.5
- old
+ new
@@ -1,13 +1,26 @@
cukeforker
==========
Forking cukes and VNC displays.
+[![Build Status](https://secure.travis-ci.org/jarib/cukeforker.png)](http://travis-ci.org/jarib/cukeforker)
+
Usage
=============
-
-TODO.
+```ruby
+ # parallelize per feature
+ CukeForker::Runner.run Dir['features/**/*.feature'],
+ :max => 4 # number of workers
+ :out => "/path/to/reports", # output path
+ :format => :html # passed to `cucumber --format`,
+ :extra_args => %w[--extra arguments] # passed to cucumber,
+ :vnc => true # manage a pool of VNC displays, assign one per worker.
+
+ # parallelize per scenario, with one JUnit XML file per scenario.
+ CukeForker::Runner.run CukeForker::Scenarios.tagged(%W[@edition ~@wip])
+ :extra_args => %W[-f CukeForker::Formatters::JunitScenarioFormatter --out results/junit]
+```
Note on Patches/Pull Requests
=============================
* Fork the project.