first commit

README.md

@@ -0,0 +1,35 @@
+# MySubaru!GO
+Is a simple API client to interact with My Subaru service (https://www.mysubaru.com/) via HTTP, written in Go
+
+## News
+  * v0.0.0-dev First public release on April 11, 2023
+
+## Features
+  * Simple and chainable methods for settings and request
+
+## Installation
+```bash
+# Go Modules
+go get github.com/alex-savin/go-mysubaru
+```
+
+## Usage
+The following samples will assist you to become as comfortable as possible with mysubaru library.
+```go
+// Import hassky into your code and refer it as `mysubaru`.
+import "github.com/alex-savin/go-mysubaru"
+```
+
+#### Create a new MySubaru connection and get a car by VIN
+```go
+// Create a MySubaru Client
+mysubaru, _ := New()
+outback := mysubaru.GetVehicleByVIN("VIN-CODE-HERE")
+```
+
+#### Start/Stop Lights request
+```go
+outback.LightsStart()
+time.Sleep(30 * time.Second)
+outback.LightsStop()
+```