Merge pull request #20 from elimity-com/feature/18-setup-versioning

Add readme with compatibility table

README.md

@@ -0,0 +1,45 @@
+# Elimity Insights Go client
+
+This Go module provides a client for connector interactions with an Elimity
+Insights server.
+
+## Usage
+
+```go
+package main
+
+import (
+	"github.com/elimity-com/insights-client-go"
+	"time"
+)
+
+func main() {
+	client, err := insights.NewClient("https://local.elimity.com:8081/api", "token")
+	if err != nil {
+		panic(err)
+	}
+
+	now := time.Now()
+	log := insights.ConnectorLog{
+		Level:     insights.Info,
+		Message:   "Hello world!",
+		Timestamp: now,
+	}
+	logs := []insights.ConnectorLog{log}
+	if err := client.CreateConnectorLogs(logs); err != nil {
+		panic(err)
+	}
+}
+```
+
+## Installation
+
+```sh
+$ go get github.com/elimity-com/insights-client-go
+```
+
+## Compatibility
+
+| Client version | Insights version |
+| -------------- | ---------------- |
+| 1              | ^2.7             |