From 1016e7124120eb6a93fa763e84a6dffee97d516e Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Mon, 3 Oct 2022 20:52:46 +0200 Subject: Docs: Use pkg.go.dev for Go documentation --- docs/src/api/go/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (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 e27a247..1202cf2 100644 --- a/docs/src/api/go/README.md +++ b/docs/src/api/go/README.md @@ -7,4 +7,6 @@ import "github.com/eduvpn/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. +The documentation to then use this API is online at [pkg.go.dev](https://pkg.go.dev/github.com/eduvpn/eduvpn-common). + +[We also provide an example](./example.md). -- cgit v1.2.3