Improve README

README.md

@@ -9,10 +9,33 @@
 
 ![Catalog Diff](https://raw.githubusercontent.com/camptocamp/puppet-catalog-diff/master/catalog-diff.png)
 
+
+#### Table of Contents
+
+1. [Overview](#overview)
+1. [Module Description](#module-description)
+1. [Setup](#setup)
+  1. [Set up node discovery](#set-up-node-discovery)
+  1. [Set up auth.conf](#set-up-auth-conf)
+1. [Usage](#usage)
+  1. [Multi threaded compile requests](#multi-threaded-compile-requests)
+  1. [Fact search](#fact-search)
+  1. [Changed depth](#changed-depth)
+  1. [Output report](#output-report)
+1. [Limitations](#limitations)
+1. [Authors](#authors)
+1. [Contributors](#contributors)
+1. [See Also](#see-also)
+  1. [Upload facts to PuppetDB](#upload-facts-to-puppetdb)
+
+
 ## Overview
 
 A tool to compare two Puppet catalogs.
 
+
+## Module Description
+
 While upgrading versions of Puppet or refactoring Puppet code you want to
 ensure that no unexpected changes will be made prior to committing the changes.
 
@@ -42,7 +65,7 @@ able to compile catalogs on the new Master. This is useful when upgrading Puppet
 To upload facts to PuppetDB on a Master see the [Upload facts](#upload-facts-to-puppetdb) script.
 
 
-## Usage
+## Setup
 
 
 ### Set up node discovery
@@ -103,7 +126,7 @@ If you are on Puppet 6, you can activate the certless API instead with:
 ```
 
 
-### Running
+## Usage
 
 
 Example:
@@ -169,7 +192,7 @@ save the output with escaped color. If you want to view that text report run
 `less -r lastrun-$$.log`
 
 
-### Limitations
+## Limitations
 
 This code only validates the catalogs, it cannot tell you if the behavior of
 the providers that interpret the catalog has changed so testing is still
@@ -184,6 +207,18 @@ viewed in markdown using the Rakefile in this directory.
 A web viewer is also available at [https://github.com/camptocamp/puppet-catalog-diff-viewer](https://github.com/camptocamp/puppet-catalog-diff-viewer)
 
 
+## Authors
+
+R.I.Pienaar <rip@devco.net> / www.devco.net / @ripienaar  
+Zack Smith <zack@puppetlabs.com> / @acidprime  
+Raphaël Pinson <raphael.pinson@camptocamp.com> / @raphink
+
+
+## Contributors
+
+The list of contributors can be found at: [https://github.com/camptocamp/puppet-catalog-diff/graphs/contributors](https://github.com/camptocamp/puppet-catalog-diff/graphs/contributors).
+
+
 ## See also
 
 ### Upload facts to PuppetDB
@@ -214,9 +249,3 @@ It's been verified to work with uploading facts from Puppet Masters running Pupp
 version 3 to Masters running version 5. It uses the [`/puppet/v3/facts/` API](https://puppet.com/docs/puppet/6.17/http_api/http_facts.html)
 which is available in version 3 and >= 5 of Puppet. This API was removed in Puppet 4 but
 added again in 5.
-
-## Authors
-R.I.Pienaar <rip@devco.net> / www.devco.net / @ripienaar  
-Zack Smith <zack@puppetlabs.com> / @acidprime  
-Raphaël Pinson <raphael.pinson@camptocamp.com> / @raphink
-See change log