diff options
Diffstat (limited to 'docs/src/api/overview')
| -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. |