Merge pull request uecode#18 from uecode/updated-docs

fix for documentation

Author: Keith Kirk

README.md

@@ -8,23 +8,26 @@ This bundle allows you to easily consume messages from Push Queues by simply
 tagging your services and relying on Symfony's event dispatching - without
 needing to run a daemon or background process to continuously poll your queue.
 
-**You can find the full documentation at [qpush-bundle.readthedocs.org](http://qpush-bundle.rtfd.org)**
+**Full Documentation:** [qpush-bundle.readthedocs.org](http://qpush-bundle.rtfd.org)
 
 ##Installation
 
 The bundle should be installed through composer.
 
-####Add the bundle to your `composer.json` file
+####Add the bundle to your composer.json file
 
 ```json
-"require": {
- "uecode/qpush-bundle": "~1.1.0",
+{
+ "require": {
+ "uecode/qpush-bundle": "~1.1",
+ }
 }
 ```
 
 ####Update AppKernel.php of your Symfony Application
 
-Add the `UecodeQPushBundle` to your kernel bootstrap sequence, in the `$bundles` array.
+Add the `UecodeQPushBundle` to your kernel bootstrap sequence, in the `$bundles`
+array.
 
 ```php
 public function registerBundles()
@@ -41,8 +44,8 @@ public function registerBundles()
 ##Basic Configuration:
 
 Here is a basic configuration that would create a push queue called 
-`my_queue_name` using AWS. You can read about the supported providers and
-provider options in the full documentation.
+`my_queue_name` using AWS or IronMQ. You can read about the supported providers
+and provider options in the full documentation.
 
 ######Example
 
@@ -55,9 +58,12 @@ uecode_qpush:
  key: <aws api key>
  secret: <aws secret>
  region: us-east-1
+ ironmq:
+ token: <iron mq oauth token>
+ project_id: <iron mq project id>
  queues:
  my_queue_name:
- provider: aws
+ provider: aws #or ironmq
  options:
  push_notifications: true
  subscribers:
@@ -121,7 +127,7 @@ public function onMessageReceived(MessageEvent $event)
 ```
 
 The `Message` objects contain the provider specific message id, a message body,
-and a collection of provider specific `metadata`.
+and a collection of provider specific metadata.
 
 These properties are accessible through simple getters. 
 

docs/_build/doctrees/configuration.doctree

@@ -18,7 +18,7 @@ Providers may have their own dependencies that should be added to your ``compose
 For specific instructions on how to configure each provider, please view their documents.
 
 .. toctree::
- :maxdepth: 1
+ :maxdepth: 2
 
  aws-provider
  iron-mq-provider

docs/_build/doctrees/environment.pickle

@@ -9,7 +9,7 @@ The bundle should be installed through composer.
 
  {
  "require": {
- "uecode/qpush-bundle": "~1.1.0",
+ "uecode/qpush-bundle": "~1.1",
  }
  }
 

docs/_build/doctrees/index.doctree

@@ -57,7 +57,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <p><strong>Add the bundle to composer</strong></p>
 <div class="highlight-js"><div class="highlight"><pre><span class="p">{</span>
  <span class="s2">&quot;require&quot;</span><span class="o">:</span> <span class="p">{</span>
- <span class="s2">&quot;uecode/qpush-bundle&quot;</span><span class="o">:</span> <span class="s2">&quot;~1.1.0&quot;</span><span class="p">,</span>
+ <span class="s2">&quot;uecode/qpush-bundle&quot;</span><span class="o">:</span> <span class="s2">&quot;~1.1&quot;</span><span class="p">,</span>
  <span class="p">}</span>
 <span class="p">}</span>
 </pre></div>

docs/_build/doctrees/installation.doctree

@@ -18,7 +18,7 @@ Providers may have their own dependencies that should be added to your ``compose
 For specific instructions on how to configure each provider, please view their documents.
 
 .. toctree::
- :maxdepth: 1
+ :maxdepth: 2
 
  aws-provider
  iron-mq-provider