-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51 from Annopaolo/add-readme
Add README.md
- Loading branch information
Showing
1 changed file
with
13 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Astarte Go Device SDK | ||
|
||
Go Device SDK for [Astarte](https://github.com/astarte-platform). Create Astarte Devices and Simulators with Go. | ||
|
||
The SDK simplifies all the low level operations of the [Astarte MQTTv1 protocol](https://docs.astarte-platform.org/latest/080-mqtt-v1-protocol.html) (such as pairing, property sync, data validation, reconnection...) and exposes an high-level API to interact with Astarte from your device. | ||
|
||
## Requirements | ||
|
||
If you plan to use the default persistent storage (SQLite), you'll have to compile using `CGO_ENABLED=1`, as the `go-sqlite3` driver uses *cgo*. | ||
|
||
## Getting started | ||
|
||
Have a look at the `examples/` folder for a minimal example showing how to register a Device and send data. |