Documentation.

Author: jcustenborder

README.md

@@ -1,19 +1,35 @@
 # Introduction
 
-Kafka Connect transform to assist with archiving to S3.
+# Transformations
 
-## Kafka 0.11.x and newer
-
-```properties
+## Archive
 
+The Archive transformation is used to help preserve all of the data for a message when archived to S3.
 
-```
+### Configuration
 
-## Kafka 0.10.x and older
+| Name | Type | Importance | Default Value | Validator | Documentation|
+| ---- | ---- | ---------- | ------------- | --------- | -------------|
 
-```properties
 
+#### Standalone Example
 
+```properties
+transforms=Archive
+transforms.Archive.type=com.github.jcustenborder.kafka.connect.archive.Archive
+# The following values must be configured.
+```
 
+#### Distributed Example
+
+```json
+{
+    "name": "connector1",
+    "config": {
+        "connector.class": "com.github.jcustenborder.kafka.connect.archive.Archive",
+        "transforms": "Archive",
+        "transforms.Archive.type": "com.github.jcustenborder.kafka.connect.archive.Archive",
+    }
+}
 ```
 

src/test/java/com/github/jcustenborder/kafka/connect/archive/DocumentationTest.java

@@ -0,0 +1,10 @@
+package com.github.jcustenborder.kafka.connect.archive;
+
+import com.github.jcustenborder.kafka.connect.utils.BaseDocumentationTest;
+
+public class DocumentationTest extends BaseDocumentationTest {
+  @Override
+  protected String[] packages() {
+    return new String[]{this.getClass().getPackage().getName()};
+  }
+}