From b1f2d28795635bbfc67e9bab4ef4b8f86a67241a Mon Sep 17 00:00:00 2001
From: "Steve L. Nyemba" <steve@the-phi.com>
Date: Mon, 7 Aug 2017 15:21:00 +0000
Subject: [PATCH] Update 'README.md'

initialization
---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4ffe1ff..242d21a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
-# data-transport
+# Introduction
 
-reusable data transport object
\ No newline at end of file
+This project implements an abstraction of objects that can have access to a variety of data stores, implementing read/write functions associated and specific to the data-sources. The classes implement functionalities against :
+
+    - Rabbitmq-server
+    - Couchdb-server
+    - Http Session : {csv,tab,pipe,sql}
+    - Disk{Reader|Writer} : csv, tab, pipe, sql on disk
+
+
+### Usage
+
+The basic usage revolves around a factory class (to be a singleton)
+
+    import transport
+    
+    p = {"uri":"https://your-server:5984","dbname":"mydatabase","doc":"doc_id"}
+    couchdb = transport.Factory.instance(type='CouchdbReader',args=p)
+    
+    #
+    # let's execute a view
+    #
+    result = couchdb.view('view_name/function',key=value)
+    info   = couchdb.read()
\ No newline at end of file