From fcd6cef3fbd7607089918161e86bf8ce67325f4c Mon Sep 17 00:00:00 2001 From: Jonathan Philip Knoblauch Date: Wed, 18 May 2016 16:16:11 +0200 Subject: [PATCH] Updated readme.md due to changes modules structure Signed-off-by: Jonathan Philip Knoblauch --- .../README.md | 8 ++--- .../README.md | 29 +++++-------------- .../README.md | 8 ++--- .../hawkbit-example-mgmt-simulator/README.md | 2 +- 4 files changed, 16 insertions(+), 31 deletions(-) diff --git a/examples/hawkbit-example-core-feign-client/README.md b/examples/hawkbit-example-core-feign-client/README.md index 27d1ea04e..bcded015e 100644 --- a/examples/hawkbit-example-core-feign-client/README.md +++ b/examples/hawkbit-example-core-feign-client/README.md @@ -1,13 +1,13 @@ -# Eclipse.IoT hawkBit - Example Feign Core Client +# Eclipse.IoT hawkBit - Example Core Feign Client -This modules contains core resources that are needed by the hawkBit Example DDI Client and the hawkBit Example Management Spring Client. +This modules contains core resources that are needed by the hawkBit Example DDI Feign Client and the hawkBit Example Mgmt Feign Client. # Compile -#### Build hawkbit-example-feign-core-client +#### Build hawkbit-example-core-feign-client ``` -$ cd hawkbit/examples/hawkbit-example-feign-core-client +$ cd hawkbit/examples/hawkbit-example-core-feign-client $ mvn clean install ``` diff --git a/examples/hawkbit-example-ddi-feign-client/README.md b/examples/hawkbit-example-ddi-feign-client/README.md index 8b016ed5e..d1e1bd18d 100644 --- a/examples/hawkbit-example-ddi-feign-client/README.md +++ b/examples/hawkbit-example-ddi-feign-client/README.md @@ -1,29 +1,14 @@ -# Eclipse.IoT hawkBit - Example DDI Client +# Eclipse.IoT hawkBit - Example DDI Feign Client -The hawkBit Example DDI Client is an implementation of a simulated device/target that communicates with the hawkBit server via the DDI API. +This modules contains an example feign client implementation based on the DDI API. -# Compile, Run and Getting Started +Powered by [Feign](https://github.com/Netflix/feign). -#### Build hawkbit-example-ddi-client +# Compile + +#### Build hawkbit-example-ddi-feign-client ``` -$ cd hawkbit/examples/hawkbit-example-ddi-client +$ cd hawkbit/examples/hawkbit-example-ddi-feign-client $ mvn clean install ``` - -#### Run hawkBit Example DDI Client - -Start the [hawkBit example app](../hawkbit-example-app). - -Create an instance of the hawkBit Example DDI Client and run it as thread e.g. in the ExecutorService. - -``` -DdiExampleClient ddiExampleClient = new DdiExampleClient("http://localhost:8080/", "controllerIdName", "DEFAULT", new DoNotSaveArtifacts()); -ExecutorService executorService = Executors.newFixedThreadPool(1); -executorService.execute(ddiExampleClient); -``` - -#### Getting started with hawkBit Example DDI Client - -After the hawkBit Example DDI Client has started it will poll once against the given hawkBit server and form then depending on your polling configuration. After the hawkBit Example DDI Client has polled successful you will see a target in the deployment view regarding the given controller id of your hawkBit Example DDI Client. You can know assign a distributionSet to the target and let the hawkBit Example DDI Client simulated an update. - diff --git a/examples/hawkbit-example-mgmt-feign-client/README.md b/examples/hawkbit-example-mgmt-feign-client/README.md index b73ddd96b..3a2dcf61b 100644 --- a/examples/hawkbit-example-mgmt-feign-client/README.md +++ b/examples/hawkbit-example-mgmt-feign-client/README.md @@ -1,15 +1,15 @@ -# Eclipse.IoT hawkBit - Example Management Client +# Eclipse.IoT hawkBit - Example Management Feign Client -This modules contains an example feign client implementation based on the Mgmt API. +This modules contains an example feign client implementation based on the Management API. Powered by [Feign](https://github.com/Netflix/feign). # Compile -#### Build hawkbit-example-mgmt-client +#### Build hawkbit-example-mgmt-feign-client ``` -$ cd hawkbit/examples/hawkbit-example-mgmt-client +$ cd hawkbit/examples/hawkbit-example-mgmt-feign-client $ mvn clean install ``` diff --git a/examples/hawkbit-example-mgmt-simulator/README.md b/examples/hawkbit-example-mgmt-simulator/README.md index 9e11e212d..f49d84320 100644 --- a/examples/hawkbit-example-mgmt-simulator/README.md +++ b/examples/hawkbit-example-mgmt-simulator/README.md @@ -1,6 +1,6 @@ # Eclipse.IoT hawkBit - Management API Example Client -Example Spring Boot client that shows how to efficiently use the hawkBit Example Management Client and the hawkBit Management API. +Example Spring Boot client that shows how to efficiently use the hawkBit Example Management Fiegn Client and the hawkBit Management API. Powered by [Feign](https://github.com/Netflix/feign).