Migrated interfaces documentation to wiki.

This commit is contained in:
Kai Zimmermann
2016-03-16 11:49:46 +01:00
parent de446bf022
commit d33f0b3cb5
3 changed files with 6 additions and 264 deletions

View File

@@ -4,9 +4,14 @@ Build: [![Circle CI](https://circleci.com/gh/eclipse/hawkbit.svg?style=svg)](htt
[hawkBit](https://projects.eclipse.org/projects/iot.hawkbit) is an domain independent back end solution for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
# Documentation
see [hawkBit Wiki](https://github.com/eclipse/hawkbit/wiki)
# Contact us
* Want to chat with the team behind hawkBit? [![Join the chat at https://gitter.im/eclipse/hawkbit](https://badges.gitter.im/eclipse/hawkbit.svg)](https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
* Having issues with hawkBit? Open a [GitHub issue](https://github.com/eclipse/hawkbit/issues).
* You can also check out our [Project Homepage](https://projects.eclipse.org/projects/iot.hawkbit) for further contact options.
@@ -14,7 +19,7 @@ Build: [![Circle CI](https://circleci.com/gh/eclipse/hawkbit.svg?style=svg)](htt
We are not providing an off the shelf installation ready hawkBit update server. However, we recommend to check out the [Example Application](examples/hawkbit-example-app) for a runtime ready Spring Boot based update server that is empowered by hawkBit.
#### Clone and build hawkBit
#### Clone and build hawkBit
```
$ git clone https://github.com/eclipse/hawkbit.git
$ mvn clean install
@@ -45,11 +50,6 @@ $ java jar ./examples/hawkbit-mgmt-api-client/target/hawkbit-mgmt-api-client-
* And of course tons of usability improvements and bug fixes.
# Device Integration
There are two device integration APIs provided by the hawkbit update server.
* [Direct Device Integration API (HTTP)](DDIA.md)
* [Device Management Federation API (AMQP)](DMFA.md)
# Modules
`hawkbit-core` : core elements.
`hawkbit-security-core` : core security elements.