summaryrefslogtreecommitdiff
path: root/docs/src/api/go/example.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2022-10-03 20:52:46 +0200
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2022-10-03 20:52:46 +0200
commit1016e7124120eb6a93fa763e84a6dffee97d516e (patch)
tree8bd6a2f90506ff28bdf39b63f094e1476a3939c1 /docs/src/api/go/example.md
parent5ec812f0e1dc00d8633bf129e11295cfd8d90b71 (diff)
Docs: Use pkg.go.dev for Go documentation
Diffstat (limited to 'docs/src/api/go/example.md')
-rw-r--r--docs/src/api/go/example.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/src/api/go/example.md b/docs/src/api/go/example.md
index 82baad8..a7f293b 100644
--- a/docs/src/api/go/example.md
+++ b/docs/src/api/go/example.md
@@ -1,13 +1,17 @@
# Example with comments
The following is an example [in the repository](https://github.com/eduvpn/eduvpn-common/blob/main/cmd/cli/main.go). It is a command line client with the following flags
```
--get-institute string
- The url of an institute to connect to
--get-secure string
- Gets secure internet servers.
--get-secure-all string
- Gets certificates for all secure internet servers. It stores them in ./certs. Provide an URL for the home server e.g. nl.eduvpn.org.
+ -get-custom string
+ The url of a custom server to connect to
+ -get-institute string
+ The url of an institute to connect to
+ -get-secure string
+ Gets secure internet servers
```
```go
{{#include ../../../../cmd/cli/main.go}}
```
+
+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).