SUMOK-9 Added README file

Author: Juan Pablo Diaz-Vaz

README.md

@@ -0,0 +1,39 @@
+# Kinesis-Sumologic Connector
+
+The **Kinesis-Sumologic Connector** is a Java connector that acts as a pipeline between an [Amazon Kinesis] stream and a [Sumologic] Collection. Data gets fetched from the Kinesis Stream, transformed into a POJO and then sent to the Sumologic Collection as JSON.
+
+## Requirements
+
+ + [Java JDK 1.7]: This connector has been built with Java version 1.7.
+ + [Ant]: A build.xml script has been provided to build the connector with Ant.
+ + [AWS Kinesis Account]: An Amazon AWS Kinesis account to use as a source of data.
+ + [Sumologic Account]: A Sumologic account to use as a destination.
+
+## Overview
+
+Incoming records from one (or many) Shards of an AWS Kinesis Stream will be read using the [Kinesis Client Library]. Records will be:
+ + **Transformed**: Raw records will be transformed into a POJO using the KinesisMessageModel class and then serialized.
+ + **Filtered**: A filter may be applied to the records. Default filter will let all records pass.
+ + **Buffered**: A custom buffer may be used to define thresholds that, when crossed, will flush all records into the emitter.
+ + **Emitted**: The records will get send to the Sumologic Collector.
+
+## Configuration
+
+A sample properties file is provided, which should be modified to use your AWS Accounts (**accessKey** and **secretKey**), Kinesis Stream(**kinesisInputStream**), Sumologic HTTP source (**sumologicUrl**) and App Name (**appName**).
+
+## Running the Connector
+
+After modifying the .properties file, run the connector by executing the ant build script 
+To download the needed dependencies execute **ant setup**
+To build and execute the connector execute **ant run**
+
+
+
+
+[Amazon Kinesis](http://aws.amazon.com/kinesis/)
+[Sumologic](https://www.sumologic.com/)
+[Java JDK 1.7](http://www.oracle.com/technetwork/java/javase/overview/index.html)
+[Ant](http://ant.apache.org/)
+[AWS Kinesis Account](http://aws.amazon.com/account/)
+[Sumologic Account](https://www.sumologic.com/pricing/)
+[Kinesis Client Library](https://github.com/awslabs/amazon-kinesis-client/)