From 7bb7885f6eb19547b906513d2664e3730ef5b593 Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Thu, 5 May 2022 17:47:36 +0200 Subject: Docs: Add API and building improvements --- docs/src/api/go/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/src/api/go/README.md') diff --git a/docs/src/api/go/README.md b/docs/src/api/go/README.md index 452b575..6106f1e 100644 --- a/docs/src/api/go/README.md +++ b/docs/src/api/go/README.md @@ -1 +1,10 @@ # Go +The API that has no additional wrapper code is the Go API. To begin to use the Go library in a Go client you first need to import it: + +```go +import "github.com/jwijenbergh/eduvpn-common" +``` + +This brings the library into scope using the eduvpn-common prefix. + +The functions that we define all operate on a `VPNState` object, thus to call a function it needs to be first created and then the function needs to be called. An example of how to tie all of this together is done at the end. -- cgit v1.2.3