Update docs

Author: timja

README.md

@@ -1,19 +1,64 @@
-# junit-postgresql
+# Junit SQL Storage Plugin
 
-[![Build Status](https://ci.jenkins.io/job/Plugins/job/junit-postgresql-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/junit-postgresql-plugin/job/master/)
-[![Contributors](https://img.shields.io/github/contributors/jenkinsci/junit-postgresql-plugin.svg)](https://github.com/jenkinsci/junit-postgresql-plugin/graphs/contributors)
-[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/junit-postgresql.svg)](https://plugins.jenkins.io/junit-postgresql)
-[![GitHub release](https://img.shields.io/github/release/jenkinsci/junit-postgresql-plugin.svg?label=changelog)](https://github.com/jenkinsci/junit-postgresql-plugin/releases/latest)
-[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/junit-postgresql.svg?color=blue)](https://plugins.jenkins.io/junit-postgresql)
+[![Build Status](https://ci.jenkins.io/job/Plugins/job/junit-sql-storage-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/junit-sql-storage-plugin/job/master/)
+[![Contributors](https://img.shields.io/github/contributors/jenkinsci/junit-sql-storage-plugin.svg)](https://github.com/jenkinsci/junit-sql-storage-plugin/graphs/contributors)
+[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/junit-sql-storage.svg)](https://plugins.jenkins.io/junit-sql-storage)
+[![GitHub release](https://img.shields.io/github/release/jenkinsci/junit-sql-storage-plugin.svg?label=changelog)](https://github.com/jenkinsci/junit-sql-storage-plugin/releases/latest)
+[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/junit-sql-storage.svg?color=blue)](https://plugins.jenkins.io/junit-sql-storage)
 
 ## Introduction
 
-TODO Describe what your plugin does here
+Implements the pluggable storage API for the [Junit plugin](https://plugins.jenkins.io/junit/).
+
+In common CI/CD use-cases a lot of the space is consumed by test reports. 
+This data is stored within JENKINS_HOME, and the current storage format requires huge overheads when retrieving statistics and, especially trends. 
+In order to display trends, each report has to be loaded and then processed in-memory.
+
+The main purpose of externalising Test Results is to optimize Jenkins logic by querying the desired data from specialized external storage.
+
+This plugin adds a SQL extension, any database should work although we're only currently testing against PostgreSQL.
+
+Tables will be automatically created.
 
 ## Getting started
 
-TODO Tell users how to configure your plugin here, include screenshots, pipeline examples and 
-configuration-as-code examples.
+Install your database vendor specific plugin, you can use the Jenkins plugin manager to search for it:
+
+`${JENKINS_URL}/pluginManager/available?filter=Database`
+
+e.g. you could install the [PostgreSQL Database](https://plugins.jenkins.io/database-postgresql/) plugin.
+
+### UI
+
+Manage Jenkins => Configure System => Junit
+
+In the dropdown select 'SQL Database'
+
+![Junit SQL plugin configuration](images/junit-sql-config-screen.png)
+
+Manage Jenkins => Configure System => Global Database
+
+Select the database implementation you want to use and click 'Test Connection' to verify Jenkins can connect
+
+![Junit SQL plugin database configuration](images/junit-sql-database-config.png)
+
+Click 'Save'
+
+### Configuration as code
+
+```yaml
+unclassified:
+  globalDatabaseConfiguration:
+    database:
+      postgreSQL:
+        database: "jenkins"
+        hostname: "${DB_HOST_NAME}"
+        password: "${DB_PASSWORD}"
+        username: "${DB_USERNAME}"
+        validationQuery: "SELECT 1"
+  junitTestResultStorage:
+    storage: "database"
+```
 
 ## Contributing
 

images/junit-sql-config-screen.png

@@ -1,4 +1,4 @@
 <?jelly escape-by-default='true'?>
 <div>
-    Provides a pluggable storage extension for the junit plugin with a SQL database
+    Provides a pluggable storage extension for the junit plugin with a SQL database.
 </div>