From 3299906d4d5d64a1509dbf616bd9ce89a4543049 Mon Sep 17 00:00:00 2001 From: Jonathan Philip Knoblauch Date: Tue, 3 May 2016 14:01:42 +0200 Subject: [PATCH] Added new readme.md for DDI download API and updated existing readme.md Signed-off-by: Jonathan Philip Knoblauch --- README.md | 7 ++++--- hawkbit-ddi-dl-api/README.md | 12 ++++++++++++ 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 hawkbit-ddi-dl-api/README.md diff --git a/README.md b/README.md index ab90e4263..31d853dc8 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ $ java -jar ./examples/hawkbit-mgmt-api-client/target/hawkbit-mgmt-api-client-#v # Modules -* `examples` : HawkBit examples +* `examples` : hawkBit examples * `hawkbit-artifact-repository-mongo` : Artifact repository implementation to mongoDB. * `hawkbit-autoconfigure` : Spring-boot auto-configuration. * `hawkbit-cache-redis` : Spring cache manager configuration and implementation with redis, distributed cache and distributed events. @@ -70,14 +70,15 @@ $ java -jar ./examples/hawkbit-mgmt-api-client/target/hawkbit-mgmt-api-client-#v * `hawkbit-http-security` : Implementation for security filters for HTTP. * `hawkbit-mgmt-api` : The hawkBit Management API * `hawkbit-mgmt-resource` : Implementation of the hawkBit Management API +* `hawkbit-mgmt-ui` : Vaadin UI. * `hawkbit-repository` : Repository implementation based on SQL for all meta-data. * `hawkbit-rest-core` : Core elements for the rest modules. * `hawkbit-security-core` : Core security elements. -* `hawkbit-security-integration` : Security integration elements to integrate security into hawkbit. +* `hawkbit-security-integration` : Security integration elements to integrate security into hawkBit. * `hawkbit-system-api` : The hawkBit System API * `hawkbit-system-resource` : Implementation of the hawkBit System API * `hawkbit-test-report` : Test reports -* `hawkbit-ui` : Vaadin UI. + diff --git a/hawkbit-ddi-dl-api/README.md b/hawkbit-ddi-dl-api/README.md new file mode 100644 index 000000000..703ef2916 --- /dev/null +++ b/hawkbit-ddi-dl-api/README.md @@ -0,0 +1,12 @@ +# Eclipse.IoT hawkBit - DDI Download API + +This module is part of the Direct Device Integration (DDI) API and is used by devices/targets for downloading artifacts through HTTP. + +# Compile + +#### Build hawkbit-ddi-dl-api + +``` +$ cd hawkbit/hawkbit-ddi-dl-api +$ mvn clean install +```