diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-03-21 14:08:05 +0100 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2023-09-25 09:43:37 +0200 |
| commit | f0cf377c1ccfbf3ea0cd791b33c90be275902c5b (patch) | |
| tree | a8a58f39404b799901eb17d4e0e002310038c29c /docs | |
| parent | a7f937589dfaeb5866677a1064cc4ab810c2995a (diff) | |
Docs API: Fix Got Config description
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/api/overview/README.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/src/api/overview/README.md b/docs/src/api/overview/README.md index 361b102..4b5f3d5 100644 --- a/docs/src/api/overview/README.md +++ b/docs/src/api/overview/README.md @@ -79,7 +79,7 @@ The `states` is an enumeration of the possible states that the state machine has - `Ask Profile`: eduvpn-common is asking the client for a profile - Data with this transition: `types.server.Profiles`. - `Chosen Profile`: A profile has been chosen by the client -- `Got Config`: A VPN Configuration has been obtained for the current server and the Go library is ready to connect +- `Got Config`: A VPN Configuration has been obtained for the current server and the client should be ready to connect The states with data are required transitions, handle them by returning True/non-zero (e.g. 1) in your callback function. We will discuss this callback function later. |