Improves documentation. New release.

Author: outofcoffee

CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.5.0] - 2016-09-03
+### Added
+- Adds JavaScript scripting support.
+- Refactored documentation.
+
 ## [0.4.0] - 2016-08-29
 ### Added
 - Adds changelog (this document!)
@@ -14,6 +19,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Breaking change - response files are now resolved relative to the plugin configuration file, not the core configuration directory.
 
+## [0.3.4] - 2016-08-22
+### Added
+- Adds RecordInfo and record ID to context for HBase plugin.
+
 ## [0.3.3] - 2016-05-08
 ### Added
 - Adds API sandbox using swagger-ui for OpenAPI plugin.
@@ -33,7 +42,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Adds request method to script context for all plugins.
 - Adds table name to HBase plugin.
 
-## [0.2.5] - 2016-04-25
+## [0.2.5] - 2016-04-26
 ### Added
 - Adds REST plugin support for ID field name (like HBase plugin).
 - Adds REST plugin subresources to return objects or arrays of data.

README.md

@@ -12,7 +12,7 @@ Use Imposter to:
 * decouple your integration tests from the cloud/various back-end systems and take control of your dependencies
 * quickly set up a temporary API for your mobile/web client teams whilst the real API is being built
 
-Mock responses can use simple static files, or be customised using [JavaScript](https://www.javascript.com/) or [Groovy](http://www.groovy-lang.org/) scripts. Power users can write thier own plugins in a JVM language of their choice.
+Mock responses can use simple static files, or be customised using [JavaScript](https://www.javascript.com/) or [Groovy](http://www.groovy-lang.org/) scripts. Power users can write their own plugins in a JVM language of their choice.
 
 ## Plugins
 

distro/src/main/resources/META-INF/imposter.properties

@@ -1,4 +1,4 @@
-version=0.4.0
+version=0.5.0
 
 # List of comma-separated plugin classes to load if none specified
 plugins=com.gatehill.imposter.plugin.detector.PluginDetectorImpl

docs/getting_started.md

@@ -35,7 +35,8 @@ If you want to run Imposter using Docker, use:
 
 ## Running as a standalone Java application
 
-If Docker isn't your thing, or you want to build Imposter yourself, you can create a standlone JAR file. See the _Build_ section below.
+If Docker isn't your thing, or you want to build Imposter yourself, you can create a standlone JAR file.
+See the [Build](build.md) section.
 
 Once, built, you can run the JAR as follows:
 

docs/index.md

@@ -2,6 +2,20 @@
 
 Welcome to the Imposter documentation.
 
+## Introduction
+
+Imposter is a reliable, scriptable and extensible mock server for general REST APIs,
+[OpenAPI](https://github.com/OAI/OpenAPI-Specification) (aka Swagger) specifications,
+Salesforce and HBase APIs.
+
+## What's it for?
+
+You can use Imposter to:
+
+* run standalone mocks in place of real systems
+* decouple your integration tests from the cloud/various back-end systems and take control of your dependencies
+* quickly set up a temporary API for your mobile/web client teams whilst the real API is being built
+
 ## Getting started
 
 To begin, check out our [Getting started](getting_started.md) guide.
@@ -17,12 +31,12 @@ To begin, check out our [Getting started](getting_started.md) guide.
 
 Imposter uses plugins to control its behaviour and provide specialised mocks. You can load one or more plugins.
 
-The following sections describe the built-in plugins. You can also write your own, if you want to further customise behaviour.
+The following sections describe the built-in plugins. You can also write your own, if you want to customise behaviour further.
 
-* [REST plugin](docs/rest_plugin.md)
-* [OpenAPI (aka Swagger) plugin](docs/swagger_plugin.md)
-* [HBase plugin](docs/hbase_plugin.md)
-* [SFDC (Salesforce) plugin](docs/sfdc_plugin.md)
+* [REST plugin](rest_plugin.md)
+* [OpenAPI (aka Swagger) plugin](openapi_plugin.md)
+* [HBase plugin](hbase_plugin.md)
+* [SFDC (Salesforce) plugin](sfdc_plugin.md)
 
 ## Developers
 

docs/roadmap.md

@@ -1,8 +1,14 @@
 # Roadmap
 
-This section lists future ideas. Feel free to submit a suggestion by raising an issue.
+This section lists future ideas for features and improvements. Feel free to submit a suggestion by raising an issue.
+
+## Improvements
 
 * Add content type header to HBase response
 * Reuse HBase model classes for JSON serialisation
 * Execute mock processing asynchronously
 * Docker images shadow JARs should only depend on a single plugin module
+
+## Features
+
+* SAML2 plugin