Skip to content

Commit

Permalink
Merge pull request #51 from Annopaolo/add-readme
Browse files Browse the repository at this point in the history
Add README.md
  • Loading branch information
bettio authored Jun 30, 2022
2 parents 9e1009a + 77e69c6 commit c4ca29b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
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.

0 comments on commit c4ca29b

Please sign in to comment.