README.markdown in sippy_cup-0.1.0 vs README.markdown in sippy_cup-0.1.1

@@ -1,24 +1,43 @@
 Sippy Cup
----------
+=========
 
-Sippy Cup is a tool to generate [SIPp](http://sipp.sourceforge.net/) load test profiles. The goal is to take an input document that describes a load test in a very simple way (call this number, wait this many seconds, send this digit, wait a few more seconds, etc).  The ideas are taken from [LoadBot](https://github.com/mojolingo/ahn-loadbot), but the goal is for a more performant load generating tool with no dependency on Asterisk.
+Sippy Cup is a tool to generate [SIPp](http://sipp.sourceforge.net/) load test profiles and the corresponding media in PCAP format. The goal is to take an input document that describes a load test in a very simple way (call this number, wait this many seconds, send this digit, wait a few more seconds, etc).  The ideas are taken from [LoadBot](https://github.com/mojolingo/ahn-loadbot), but the goal is for a more performant load generating tool with no dependency on Asterisk.
 
 
+Requirements
+------------
+
+SippyCup relies on the following to generate scenarios and the associated media PCAP files:
+
+* Ruby 1.9.3 (2.0.0 NOT YET SUPPORTED; see [PacketFu Issue #28](https://github.com/todb/packetfu/issues/28)
+* [SIPp](http://sipp.sourceforge.net/) - Download from http://sourceforge.net/projects/sipp/files/
+
+
+Installation
+------------
+
+If you do not have Ruby 1.9.3 available (check using `ruby --version`), we recommend installing Ruby with [RVM](http://rvm.io)
+
+Once Ruby is installed, install SippyCup:
+
+```
+gem install sippy_cup
+```
+
+Now you can start creating scenario files like in the examples below.
+
+
 Example
-=======
+-------
 
 ```Ruby
 require 'sippy_cup'
 
 scenario = SippyCup::Scenario.new 'Sippy Cup', source: '192.168.5.5:10001', destination: '10.10.0.3:19995' do |s|
   s.invite
-  s.receive_trying
-  s.receive_ringing
-  s.receive_progress
-
-  s.receive_answer
+  s.wait_for_answer
   s.ack_answer
 
   s.sleep 3
   s.send_digits '3125551234'
   s.sleep 5
@@ -26,17 +45,72 @@
 
   s.receive_bye
   s.ack_bye
 end
 
-# Create the scenario XML and PCAP media. File will be named after the scenario name, in our case:
+# Create the scenario XML, PCAP media, and YAML options. File will be named after the scenario name, in our case:
 # * sippy_cup.xml
+# * sippy_cup.yml
 # * sippy_cup.pcap
 scenario.compile!
 ```
 
+The above code can either be executed as a standalone Ruby script and run with SIPp, or it can be compiled and run using rake tasks by inserting the following code into your Rakefile:
+```Ruby
+require 'sippy_cup/tasks'
+```
+Then running the rake task `rake sippy_cup:compile[sippy_cup.rb]`
+
+And finally running `rake sippy_cup:run[sippy_cup.yml]` to execute the scenario.
+
 Customize Your Scenarios
-========================
+------------------------
+
+### Alternate File Path
+
+Don't want your scenario to end up in the same directory as your script? Need the filename to be different than the scenario name? No problem! Try:
+
+```Ruby
+my_opts = { source: '192.168.5.5:10001', destination: '10.10.0.3:19995', filename: '/path/to/somewhere' }
+s = SippyCup::Scenario.new 'SippyCup', my_opts do
+  ...
+end
+```
+
+This will create the files `somewhere.xml`, `somewhere.pcap`, and `somewhere.yml` in the `/path/to/` directory.
+
+### Customizing the Test Run
+
+By default, sippy cup will automatically generate a YAML file with the following contents:
+```YAML
+---
+:source: 127.0.0.1
+:destination: 127.0.0.1
+:scenario: /path/to/scenario.xml
+:max_concurrent: 10
+:calls_per_second: 5
+:number_of_calls: 20
+```
+
+Each parameter has an impact on the test, and may either be changed once the YAML file is generated or specified in the options hash for `SippyCup::Scenario.new`. In addition to the default parameters, some additional parameters can be set:
+<dl>
+  <dt>:source_port:</dt>
+  <dd>The local port from which to originate SIP traffic. This defaults to port 8836</dd>
+
+  <dt>:stats_file:</dt>
+  <dd>Path to a file where call statistics will be stored in a CSV format, defaults to not storing stats</dd>
+
+  <dt>:stats_interval</dt>
+  <dd>Frequency (in seconds) of statistics collections. Defaults to 10. Has no effect unless :stats_file is also specified</dd>
+
+  <dt>:sip_user:</dt>
+  <dd>SIP username to use. Defaults to "1" (as in 1@127.0.0.1)</dd>
+
+  <dt>:full_sipp_output:</dt>
+  <dd>By default, SippyCup will hide SIPp's command line output while running a scenario. Set this parameter to `true` to see full command line output</dd>
+</dl>
+
+### Additional SIPp Attributes
 
 With Sippy Cup, you can add additional attributes to each step of the scenario:
 ```Ruby
 
 #This limits the amount of time the server has to reply to an invite (3 seconds)