Add doc to README

README.md

@@ -1,5 +1,68 @@
 # Go VVS - VVS (Verkehr Verbund Stuttgart) API library
-
+Go library wrapping VVS API
 ![Test Pipeline status](https://github.com/ownerofglory/govvs/actions/workflows/test-pipeline.yml/badge.svg)
 
-in development
+## Features
+- Journey search 
+- Departure information
+- Arrival information
+
+## Prerequisites
+- Go version >= 1.19
+
+## Usage
+### Example: departure monitor
+```go
+package main
+
+import (
+    "github.com/ownerofglory/govvs"
+    "github.com/ownerofglory/govvs/station"
+)
+
+func main() {
+    stationName := station.HAUPTBAHNHOF_TIEF_STUTTGART
+
+    // convert station name to station id (de:XXXXX:YYYY)
+    stationId, _ := station.NameToGlobalId(stationName)
+
+    req := govvs.DepartureRequest{
+        StationId: stationId,
+    }
+    resp, err := govvs.GetDepartures(req)
+    if err != nil {
+        // handle error ...
+    }
+    // process response
+    // ...
+}
+```
+
+
+### Example: journey search
+```go
+package main
+
+import (
+    "github.com/ownerofglory/govvs"
+	"github.com/ownerofglory/govvs/station"
+)
+
+func main() {
+    // convert station name to station id (de:XXXXX:YYYY)
+    origId, _ := station.NameToGlobalId(station.HAUPTBAHNHOF_TIEF_STUTTGART)
+	destId, _ := station.NameToGlobalId(station.FLUGHAFENMESSE_ECHTERDINGEN)
+
+    req := govvs.JourneyRequest{
+		OrigId: origId,
+		DstId:  destId,
+	}
+
+	resp, err := govvs.GetJourney(req)
+    if err != nil {
+        // handle error ...
+    }
+    // process response
+    // ...
+}
+```