Mailing-List: contact commits-help@bahir.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@bahir.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: prashant@apache.org
To: commits@bahir.apache.org
Message-Id: <030e1e2d76e64e4bbcad8d4ddf066740@git.apache.org>
Subject: bahir git commit: [BAHIR-48] Documentation for project README.
Date: Wed, 10 Aug 2016 07:16:36 +0000 (UTC)
archived-at: Wed, 10 Aug 2016 07:16:38 -0000

Repository: bahir
Updated Branches:
  refs/heads/master 1abeab29c -> 1ee23be3b


[BAHIR-48] Documentation for project README.


Project: http://git-wip-us.apache.org/repos/asf/bahir/repo
Commit: http://git-wip-us.apache.org/repos/asf/bahir/commit/1ee23be3
Tree: http://git-wip-us.apache.org/repos/asf/bahir/tree/1ee23be3
Diff: http://git-wip-us.apache.org/repos/asf/bahir/diff/1ee23be3

Branch: refs/heads/master
Commit: 1ee23be3b7fce1c943daad26d9fc69d0c4f0de85
Parents: 1abeab2
Author: Prashant Sharma <prashsh1@in.ibm.com>
Authored: Wed Aug 10 12:23:49 2016 +0530
Committer: Prashant Sharma <prashsh1@in.ibm.com>
Committed: Wed Aug 10 12:41:52 2016 +0530

----------------------------------------------------------------------
 README.md | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/bahir/blob/1ee23be3/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 3513773..789e7b1 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ The Initial Bahir source code (see issue [BAHIR-1](https://issues.apache.org/jir
 extracted from [Apache Spark revision 8301fad](https://github.com/apache/spark/tree/8301fadd8d269da11e72870b7a889596e3337839)
 (before the [deletion of the streaming connectors akka, mqtt, twitter, zeromq](https://issues.apache.org/jira/browse/SPARK-13843)). 
 
-## Source Code Structure
+## Source code structure
 
 Source code folder structure:
 ```
@@ -31,23 +31,34 @@ To build Bahir and its example programs, run:
 
     mvn -DskipTests clean install
 
-## Running Tests
+## Running tests
 
 Testing first requires [building Bahir](#building-bahir). Once Bahir is built, tests
 can be run using:
 
     mvn test
 
-## Example Programs
+## Example programs
 
 Each extension currently available in Apache Bahir has an example application located under the "examples" folder.
 
 
-## Online Documentation
+## Documentation
 
-Coming Soon.
+Currently, each submodule has its own README.md, with information on example usages and API.
 
+* [SQL Streaming MQTT](https://github.com/apache/bahir/blob/master/sql-streaming-mqtt/README.md)
+* [Streaming Akka](https://github.com/apache/bahir/blob/master/streaming-akka/README.md)
+* [Streaming Mqtt](https://github.com/apache/bahir/blob/master/streaming-mqtt/README.md)
+* [Streaming Zeromq](https://github.com/apache/bahir/blob/master/streaming-zeromq/README.md)
+* [Streaming Twitter](https://github.com/apache/bahir/blob/master/streaming-twitter/README.md)
 
-## A Note About Apache Spark Integration
+Furthermore, to generate scaladocs for each module:
 
-Coming soon.
+`$ mvn package`
+
+Scaladocs is generated in, `MODULE_NAME/target/site/scaladocs/index.html`.  __ Where `MODULE_NAME` is one of, `sql-streaming-mqtt`, `streaming-akka`, `streaming-mqtt`, `streaming-zeromq`, `streaming-twitter`. __
+
+## A note about Apache Spark integration
+
+Currently, each module in Bahir is available through spark packages. Please follow linking sub section in module specific [README.md](#documentation) for more details.