Add Initial Code Import

Intial Code import for dmaapClient

Issue-id: DMAAP-82
Change-Id: Ib627672d37e233b796619f93dd91f5caaf1592e4
Signed-off-by: Varun Gudisena <vg411h@att.com>

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c932da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+MR Client
+==============
+
+MR Log4J Appender
+----------------------
+
+To configure a MR Log4J appender the following parameters are available:
+
+(R) Topic [String] - The topic which you wish to publish your log messages to
+(R) Partition [String]- The partition within the Topic that you wish you publish your log messages to
+(R) Hosts [String]- A comma separated string containing the MR API server nodes you wish to connect to
+(O) MaxBatchSize [Integer] - The maximum size of the batch of log messages.
+		    When the batch grows larger than this, the messages are flushed to the topic/partition.
+(O) MaxAgeMs [Integer] - The maximum age in milliseconds of the batch.
+		When the batch age is older than this, the messages are flushed to the topic/partition.
+(O) Compress [Boolean] - Indicates whether you would like your messages compressed or not.
+
+An example can be found in ./src/main/resources/log4j.xml