summaryrefslogtreecommitdiff
path: root/docs/md/examples.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2024-11-21 15:48:24 +0100
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2024-11-26 10:54:24 +0100
commitd6987c06f48b61352289181954f5a436c5f2379f (patch)
treec1bfd0e08480fbb083db54d81d16ba1330d9e3af /docs/md/examples.md
parentb701d19e8b8b45226f6cb1090dd160eea989ca7e (diff)
Docs: Move to Mkdocs & Codeberg pages
Diffstat (limited to 'docs/md/examples.md')
-rw-r--r--docs/md/examples.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/md/examples.md b/docs/md/examples.md
new file mode 100644
index 0000000..28bfb45
--- /dev/null
+++ b/docs/md/examples.md
@@ -0,0 +1,16 @@
+# Code examples
+This chapter contains code examples that use the API
+
+## Go command line client
+The following is an example [in the repository](https://codeberg.org/eduvpn/eduvpn-common/src/branch/main/cmd/cli/main.go). It is a command line client with the following flags
+```
+ -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
+{!cmd/cli/main.go!}
+```