summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpwielebs <piotr.wielebski@nokia.com>2019-04-23 11:16:08 +0200
committerpwielebs <piotr.wielebski@nokia.com>2019-04-23 12:47:46 +0200
commit4ddbd6d544eafd16aeda6a412729f4d77ec581df (patch)
tree514d824ce765465244d6dd8c72fedd16b1ffcd0b
parente2fc40091989cba8a0fe278712158c8f813d571b (diff)
Add readme file
Change-Id: Ie50c901a1d878ab6517b6a7504de9e9c87134635 Issue-ID: DCAEGEN2-1447 Signed-off-by: pwielebs <piotr.wielebski@nokia.com>
-rw-r--r--README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..7a704e2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+DCAE SDK
+===============
+Because most services and collectors deployed on DCAE platform relies on similar microservices a common Software Development Kit has been created. It contains utilities and clients which may be used when getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK is written in Java.
+
+## Reactive programming
+Most of SDK APIs are using Project Reactor, which is one of available implementations of Reactive Streams (as well as Java 9 Flow). This way we support both high-performance, non-blocking asynchronous clients and old-school, thread-bound, blocking clients. We believe that using reactive programming can solve many cloud-specific problems for us - if used properly.
+
+## Artifacts
+
+#### Current version
+```
+<properties>
+ <sdk.version>1.1.4</sdk.version>
+</properties>
+```
+#### Maven dependencies
+```
+<dependencies>
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
+ <artifactId>cbs-client</artifactId>
+ <version>${sdk.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk.security.crypt</groupId>
+ <artifactId>crypt-password</artifactId>
+ <version>${sdk.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk</groupId>
+ <artifactId>hvvesclient-producer-api</artifactId>
+ <version>${sdk.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk</groupId>
+ <artifactId>hvvesclient-producer-impl</artifactId>
+ <version>${sdk.version}</version>
+ <scope>runtime</scope>
+ </dependency>
+
+ <!-- more to go -->
+
+</dependencies>
+```
+
+## Changelog
+Below link is a reference to an internet site which contains information about the changelog.
+[DCAE_SDK_Changelog](https://wiki.onap.org/display/DW/DCAE+SDK+Changelog)
+
+
+## License
+
+Copyright (C) 2018-2019 NOKIA Intellectual Property. All rights reserved.
+[License](http://www.apache.org/licenses/LICENSE-2.0) \ No newline at end of file