OP#581 edit Readme

README.md

@@ -1,8 +1,23 @@
 # Readme
 
-[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins)](https://jenkins.confdroid.com/job/confdroid_jenkins/)|
+[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_jenkins&style=plastic)](https://jenkins.confdroid.com/job/confdroid_jenkins/)
+[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_jenkins&metric=security_hotspots&token=sqb_ab7299f9502c7e498c19b03bb06497fa15bdd70c)](https://sonarqube.confdroid.com/dashboard?id=confdroid_jenkins)
 
-[[_TOC_]]
+- [Readme](#readme)
+  - [Synopsis](#synopsis)
+  - [WARNING](#warning)
+  - [Features](#features)
+    - [Core](#core)
+    - [Optional](#optional)
+  - [Repo Documentation](#repo-documentation)
+  - [Dependencies](#dependencies)
+  - [Deployment](#deployment)
+  - [SELINUX](#selinux)
+  - [Known Problems](#known-problems)
+  - [Support](#support)
+  - [Tests](#tests)
+  - [Contact Us](#contact-us)
+  - [Disclaimer](#disclaimer)
 
 ## Synopsis
 
@@ -14,9 +29,15 @@ Puppet 6 repo for managing Jenkins. Internal only due to access details for gitl
 
 ## Features
 
-INSTALLATION
+### Core
 
 - installs required binaries
+- manage service
+
+### Optional
+
+- create a sudoers file for the Jenkins user to allow passwordless sudo, via `js_use_sudo`. Defaults to `false`
+- manage firewall ports via `js_enable_fw`. Defaults to `true`. requires `puppetlabs-firewall`.
 
 ## Repo Documentation
 
@@ -26,7 +47,8 @@ See the full Puppet documentation including parameters in `docs/index.html`
 
 All dependencies must be included in the catalogue.
 
-- [java_cd](https://gitlab.confdroid.com/puppet/java_cd) to install java
+- [confdroid_java](https://sourcecode.confdroid.com/confdroid/confdroid_java) to install java
+- puppetlabs-firewall via r10k
 
 ## Deployment