diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-10-03 20:52:46 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-10-03 20:52:46 +0200 |
| commit | 1016e7124120eb6a93fa763e84a6dffee97d516e (patch) | |
| tree | 8bd6a2f90506ff28bdf39b63f094e1476a3939c1 /docs/src/api/go/README.md | |
| parent | 5ec812f0e1dc00d8633bf129e11295cfd8d90b71 (diff) | |
Docs: Use pkg.go.dev for Go documentation
Diffstat (limited to 'docs/src/api/go/README.md')
| -rw-r--r-- | docs/src/api/go/README.md | 4 |
1 files changed, 3 insertions, 1 deletions
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). |