Merge remote-tracking branch 'gaetanfl/cluster_strategy' into fretlink-fixes

[github/fretlink/ansible-rabbitmq.git] / README.md

diff --git a/README.md b/README.md
index b3b03adcea64556071421c27b9ee12a3ed1cbda6..15f9cdf38d2ce9cc5fee633b352662483d106265 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,65 +1,73 @@
-Role Name
-=========
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
-An [Ansible] role to install/configure [RabbitMQ]
+- [ansible-rabbitmq](#ansible-rabbitmq)
+  - [Build Status](#build-status)
+  - [Requirements](#requirements)
+  - [Vagrant](#vagrant)
+  - [Role Variables](#role-variables)
+  - [Dependencies](#dependencies)
+  - [Example Playbook](#example-playbook)
+  - [License](#license)
+  - [Author Information](#author-information)
 
-Build Status
-------------
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# ansible-rabbitmq
+
+An [Ansible](https://www.ansible.com) role to install/configure [RabbitMQ](https://www.rabbitmq.com/)
+
+## Build Status
 
 [![Build Status](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq.svg?branch=master)](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq)
 
-Requirements
-------------
+## Requirements
 
 Ensure hostnames are resolvable prior to clustering...either update /etc/hosts
 or ensure DNS is working.
 
-Vagrant
--------
+## Vagrant
 
-Spin up a 3 node HA Cluster for testing...  
-Install Ansible role on your host:  
-```
+Spin up a 3 node HA Cluster for testing...
+Install Ansible role on your host:
+
+```bash
 sudo ansible-galaxy install -r requirements.yml -f
 ```
-Now spin up your environment...  
-```
+
+Now spin up your environment...
+
+```bash
 vagrant up
 ```
-When you are done testing, tear it all down...  
-```
+
+When you are done testing, tear it all down...
+
+```bash
 ./cleanup.sh
 ```
 
-Role Variables
---------------
+## Role Variables
 
 [Role Defaults](./defaults/main.yml)
 
-Dependencies
-------------
+## Dependencies
 
 None
 
-Example Playbook
-----------------
+## Example Playbook
 
 [Example Playbook](./playbook.yml)
 
-License
--------
+## License
 
-BSD
+MIT
 
-Author Information
-------------------
+## Author Information
 
 Larry Smith Jr.
-- [@mrlesmithjr]
-- http://everythingshouldbevirtual.com
-- mrlesmithjr [at] gmail.com
-
-[@mrlesmithjr]: <https://www.twitter.com/mrlesmithjr>
 
-[Ansible]: <https://www.ansible.com>
-[RabbitMQ]: <https://www.rabbitmq.com/>
+- [@mrlesmithjr](https://www.twitter.com/mrlesmithjr)
+- [EverythingShouldBeVirtual](http://everythingshouldbevirtual.com)
+- [mrlesmithjr@gmail.com](mailto:mrlesmithjr@gmail.com)