Skip to content
Frank Hol edited this page Jan 14, 2025 · 2 revisions

Welcome to the dsh-sdk-platform-rs Wiki!

Welcome to the dsh-sdk-platform-rs wiki! This wiki is your go-to resource for understanding, using, and contributing to the SDK. Whether you're a new user or an experienced developer, you'll find valuable information to help you get the most out of the SDK.

Overview

The dsh-sdk-platform-rs is a comprehensive SDK designed to simplify the integration with the DSH platform. It supports multiple protocols, including Kafka, MQTT, and HTTP, and provides a range of utilities to make development easier and more efficient.

Getting Started

To get started with the SDK, check out the following resources:

  • crates.io: The crate is publically available on crates.io.
  • Examples: Easy to understand examples that demonstrate how to use the SDK in different scenarios.
  • Full service example: A kafka service that uses the SDK to connect to DSH incl. how to build a proper docker image of the service.
  • API Reference: Detailed documentation of all the modules and functions available in the SDK.

Key Features

  • Multi-Protocol Support: Easily connect to DSH using Kafka, MQTT, or HTTP.
  • Modular Design: Use only the components you need, with a clear and maintainable structure.
  • Extensive Utilities: Built-in support for metrics, graceful shutdown, and more.

Migration Guides

If you're upgrading from a previous version of the SDK, be sure to check out our migration guides:

Contributing

We welcome contributions from the community! If you'd like to contribute, please read our Contributing Guide to get started.

Support

If you have any questions or need help, feel free to reach out:

Thank you for using the dsh-sdk-platform-rs! We hope you find it useful and look forward to your feedback.

Happy coding!