Initial TCA commit into DCAEGEN2

[dcaegen2/analytics/tca.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..2484768
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Repository DCAE Analytics Framework Platform
+---------------------------------------------
+
+Maven GroupId:
+--------------
+com.att.ecomp.dcae.analytics
+
+Maven Parent ArtifactId:
+----------------
+dcae-analytics
+
+Maven Children Artifacts:
+------------------------
+1. dcae-analytics-test: Common test code for all DCAE Analytics Modules
+2. dcae-analytics-model: Contains models (e.g. Common Event Format) which are common to DCAE Analytics
+3. dcae-analytics-common: Contains Components common to all DCAE Analytics Modules - contains high level abstractions
+4. dcae-analytics-dmaap: DMaaP(Data Movement as a Platform) MR (Message Router)API using AAF(Authentication and Authorization Framework)
+5. dcae-analytics-tca: DCAE Analytics TCA (THRESHOLD CROSSING ALERT) Core
+6. dcae-analytics-cdap-common: Common code for all cdap modules
+7. dcae-analytics-cdap-tca: CDAP Flowlet implementation for TCA
+8. dcae-analytics-cdap-plugins: CDAP Plugins
+9. dcae-analytics-cdap-it: Cucumber and CDAP Pipeline integration tests
+
+Maven Central Artifacts Location:
+---------------------------------
+* Releases: TBD
+* Snapshots: TBD