summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2023-03-22 12:16:54 +0100
committerJeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com>2023-09-25 09:43:37 +0200
commiteb57e36d3c017bef80277e97db1009c38893ce2d (patch)
tree11ae9fa5e75492690e3db4bde349e2accc3fa1c9 /docs
parentf5fe3d75801830ab9f1d380f5b3238b9006cf48b (diff)
Exports + Client: Refactor registering a client
- Make sure the global exports state is only set on successful creating - Only call discovery when adding a server to ensure we get the most up to date args. Creating a client should have no network calls. Fixes #12 - Split creating a client in New and Register in the GO api
Diffstat (limited to 'docs')
-rw-r--r--docs/src/api/overview/README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/src/api/overview/README.md b/docs/src/api/overview/README.md
index 73ea215..32e0893 100644
--- a/docs/src/api/overview/README.md
+++ b/docs/src/api/overview/README.md
@@ -141,8 +141,14 @@ func stateCallback(oldState int, newState int, data interface{}) {
// do something
}
-c := client.Client{}
-c.Register("org.eduvpn.app.linux", "1.0.0", "/home/eduvpn/.config/eduvpn", stateCallback, true)
+c, err := client.New("org.eduvpn.app.linux", "1.0.0", "/home/eduvpn/.config/eduvpn", stateCallback, true)
+if err != nil {
+ // handle error
+}
+err := c.Register()
+if err != nil {
+ // handle error
+}
```
</details>