README: Rewrite and reorder

README.md

@@ -7,14 +7,15 @@
 ## Table of Contents
 
 1. [Overview - What is the puppet-newrelic module?](#overview)
-1. [Module Description - What does the module do?](#module-description)
+    * [Puppet 3 Support](#puppet-3-support)
 1. [Setup - The basics of getting started with puppet-newrelic](#setup)
     * [What puppet-newrelic affects](#what-puppet-newrelic-affects)
     * [Beginning with puppet-newrelic](#beginning-with-registry)
-1. [Supported agents]
-    * [PHP](#php_agent)
-    * [Java](#java_agent)
 1. [Usage - Configuration options and additional functionality](#usage)
+    * [Advanced Usage Examples](#advanced-usage-examples)
+1. [Supported agents](#supported-agents)
+    * [PHP](#php)
+    * [Java](#java)
 1. [Limitations - OS compatibility, etc.](#limitations)
 1. [Development - Guide for contributing to the module](#development)
 
@@ -26,8 +27,6 @@ This module manages and installs the New Relic Server Monitoring and PHP agents
 
 On 31st December 2016, support for Puppet 3.x was withdrawn. As as a result, **this module does not support Puppet 3**.
 
-## Module Description
-
 ## Setup
 
 ### What puppet-newrelic affects
@@ -49,7 +48,10 @@ To install the (deprecated) NewRelic Server Monitoring agent instead of the defa
       enable_server => true,
     }
 
-<a name="php_agent"></a>
+## Supported Agents
+
+### PHP
+
 To enable the PHP agent with default configuration:
 
     class { '::newrelic':
@@ -63,8 +65,6 @@ Further PHP agent configuration in Hiera:
        appname: 'ACME PHP Application'
        daemon.loglevel: 'error'
 
-### Advanced Usage Examples
-
 The below examples show how to integrate the NewRelic PHP agent with the most common web-servers, with automatic service restarts.
 
 #### Apache and `mod_php`
@@ -75,10 +75,9 @@ Assumes usage of the [Puppet Apache module](https://github.com/puppetlabs/puppet
     class { '::apache::mod::php': }
 
     class { '::newrelic::agent::php':
-      license_key  => 'your key',
-      require      => Class['::apache::mod::php'],
-      notify       => Service['httpd'],
-    }
+      license_key => 'your key',
+      require     => Class['::apache::mod::php'],
+      notify      => Service['httpd'],
 
 #### PHP-FPM
 
@@ -91,22 +90,19 @@ Assumes usage of the [Slashbunny PHP-FPM module](https://github.com/Slashbunny/p
     ::phpfpm::pool { 'main': }
 
     class { '::newrelic::agent::php':
-      license_key  => '3522b44f4c3f89c8566d5781bac6e0bb7dedab7z',
-      require      => Class['::phpfpm'],
-      notify       => Class['::phpfpm::service'],
+      license_key => '3522b44f4c3f89c8566d5781bac6e0bb7dedab7z',
+      require     => Class['::phpfpm'],
+      notify      => Class['::phpfpm::service'],
     }
 
-<a name="java_agent"></a>
-#### Java Agent
-
-Install newrelic java agent at specified version into an install directory. The install directory is recommended to be the newrelic/ under your app folder.
-Ensure permissions are correct on the install folder by using agent_user/agent_group.
+### Java
 
-**Note:** Importantly, this does not handle passing newrelic.jar to JVM_OPTS etc. Please refer to NewRelic docs here - https://docs.newrelic.com/docs/agents/java-agent/installation/install-java-agent
+This module installs a specified version of the the NewRelic Java agent into an install directory. The install directory is recommended to be `newrelic/` under your app folder. Ensure permissions are correct on the install folder by using `agent_user` and `agent_group`.
 
+**Note:** Importantly, this does not handle passing `newrelic.jar` to `JVM_OPTS` etc. Please refer to NewRelic docs here - https://docs.newrelic.com/docs/agents/java-agent/installation/install-java-agent
 
     class { '::newrelic::agent::java:
-      license_key  => '3522b44f4c3f89c8566d5781bac6e0bb7dedab7z'
+      license_key => '3522b44f4c3f89c8566d5781bac6e0bb7dedab7z'
     }
 
     # or use hiera and include
@@ -115,7 +111,7 @@ Ensure permissions are correct on the install folder by using agent_user/agent_g
 
 ## Limitations
 
-* When moving from NewRelic Server to NewRelic Infrastructure - the module only installs the new client, and does not clean up the old one
+When moving from NewRelic Server to NewRelic Infrastructure - the module only installs the new client, and does not clean up the old one.
 
 ### Windows Support