From 7816bb64b47bd6c5c128fdf1cbd951f55647c88b Mon Sep 17 00:00:00 2001
From: Branan Purvine-Riley <branan@puppetlabs.com>
Date: Thu, 3 May 2012 16:55:09 -0700
Subject: [PATCH] Cleanup the README

---
 README | 100 +++++++++++++++++++++++++++------------------------------
 1 file changed, 47 insertions(+), 53 deletions(-)

diff --git a/README b/README
index bc38879c2..af1d059b2 100644
--- a/README
+++ b/README
@@ -1,77 +1,71 @@
 # RabbitMQ Puppet Module
-
-Jeff McCune <jeff@puppetlabs.com>
-Dan Bode <dan@puppetlabs.com>
-
 This module manages the RabbitMQ Middleware service.
 
-This module will be updated and released to the forge shortly:
-(http://forge.puppetlabs.com/)
-
-RabbitMQ Packages are published in the Puppet Labs ProSvc repository at:
-[yum.puppetlabs.com](http://yum.puppetlabs.com/prosvc/)
-
 This module has been tested against 2.7.1 and is known to not support
 all features against earlier versions.
 
-classes:
+### Authors
+* Jeff McCune <jeff@puppetlabs.com>
+* Dan Bode <dan@puppetlabs.com>
+
+## Classes
 
 This module provides its core functionality through two main classes:
 
-rabbitmq::repo::apt - sets up an apt repo source for the vendor rabbitmq packages
+### rabbitmq::repo::apt
+Sets up an apt repo source for the vendor rabbitmq packages
+
+    class { 'rabbitmq::repo::apt':
+      pin    => 900,
+      before => Class['rabbitmq::server']
+    }
+
+### rabbitmq::server
+Class for installing rabbitmq-server:
 
-class { 'rabbitmq::repo::apt': 
-  pin    => 900,
-  before => Class['rabbitmq::server'] 
-}
+    class { 'rabbitmq::server':
+      port              => '5673',
+      delete_guest_user => true,
+    }
 
-rabbitmq::server - class for installing rabbitmq-server:
 
-class { 'rabbitmq::server':
-  port              => '5673',
-  delete_guest_user => true,
-}
+## Native Types
 
-This module also contains 3 native types:
-(unfortunately, you must specify the provider explicitly for these types)
+**NOTE:** Unfortunately, you must specify the provider explicitly for these types
 
-rabbitmq_user
+### rabbitmq_user
 
-- query all current users:
-#>puppet resource rabbitmq_user 
+query all current users: `$ puppet resource rabbitmq_user`
 
-- manage rabbitmq_user
-rabbitmq_user { 'dan':
-  admin    => true,
-  password => 'bar',
-  provider => 'rabbitmqctl',
-}
+    rabbitmq_user { 'dan':
+      admin    => true,
+      password => 'bar',
+      provider => 'rabbitmqctl',
+    }
 
-rabbitmq_vhost
+### rabbitmq_vhost
 
-- query all current vhosts
-#>puppet resource rabbitmq_vhost
+query all current vhosts: `$ puppet resource rabbitmq_vhost`
 
-rabbitmq_vhost { 'myhost':
-  ensure => present,
-  provider => 'rabbitmqctl',
-}
+    rabbitmq_vhost { 'myhost':
+      ensure => present,
+      provider => 'rabbitmqctl',
+    }
 
-rabbit_user_permissions:
+### rabbitmq\_user\_permissions
 
-rabbitmq_user_permissions { 'dan@myhost':
-  configure_permission => '.*',
-  read_permission      => '.*',
-  write_permission     => '.*',
-  provider => 'rabbitmqctl',
-}
+    rabbitmq_user_permissions { 'dan@myhost':
+      configure_permission => '.*',
+      read_permission      => '.*',
+      write_permission     => '.*',
+      provider => 'rabbitmqctl',
+    }
 
-rabbitmq_plugin
+### rabbitmq_plugin
 
-- query all currently enabled plugins
-#>puppet resource rabbitmq_plugin
+query all currently enabled plugins `$ puppet resource rabbitmq_plugin`
 
-rabbitmq_plugin {'rabbitmq_stomp':
-  ensure => present,
-  provider => 'rabbitmqplugins',
-}
+    rabbitmq_plugin {'rabbitmq_stomp':
+      ensure => present,
+      provider => 'rabbitmqplugins',
+    }