From e3ab29f9975077d170df1b74c2ccbffae1c9b74c Mon Sep 17 00:00:00 2001 From: Kai Zimmermann Date: Wed, 27 Jan 2016 11:37:05 +0100 Subject: [PATCH] Documentation update --- README.md | 14 +++++++++++--- examples/README.md | 7 ++++++- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 510463a1c..a99cb2a51 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,18 @@ Want to chat with the team behind hawkBit? [![Join the chat at https://gitter.im mvn install ``` -# Releases +# Run and use -* We are currently working on the first formal release under the Eclipse banner: 0.1 (see [Release 0.1 branch](https://github.com/eclipse/hawkbit/tree/release-train-0.1)) -* The master branch contains future development towards 0.2 +We are not providing an off the shelf production ready hawkBit server. However, we recommend to check out the [Example Application](examples/hawkbit-example-app) for a runtime ready Spring Boot based server that is empowered by hawkBit. + +# Releases and Roadmap + +* We are currently working on the first formal release under the Eclipse banner: 0.1 (see [Release 0.1 branch](https://github.com/eclipse/hawkbit/tree/release-train-0.1)). +* The master branch contains future development towards 0.2. We are currently focusing on: + * Rollout Management for large scale rollouts. + * Clustering capabilities for the update server. + * Upgrade of Spring Boot and Vaadin. + * And of course tones of usability improvements and bug fixes. ## Try out examples diff --git a/examples/README.md b/examples/README.md index 320ee25cc..3ad5ecf66 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,2 +1,7 @@ # Examples -TODO \ No newline at end of file + +Example projects that show how hawkBit can be used to create, run or access an hawkBit empowered update server. + +`hawkbit-device-simulator` : Simulates device software updates, leveraging the hawkBit device integration options. +`hawkbit-example-app` : Allows you to run a Spring Boot and hawkBit based update server. +`hawkbit-mgmt-api-client` : Example client for the hawkBit management API.