diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-05-01 14:19:32 +0200 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2023-09-25 09:43:37 +0200 |
| commit | d4939e8694a6762dc9de2f4027266850f49790ac (patch) | |
| tree | 89545f23dbb74766ed42dd1824c59eae35f26800 /docs/src/api/README.md | |
| parent | c654b48763592baae78b10f6fefec10be29e979b (diff) | |
Docs: Update API section for V2
Diffstat (limited to 'docs/src/api/README.md')
| -rw-r--r-- | docs/src/api/README.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/src/api/README.md b/docs/src/api/README.md index 0b7ec55..8684c9c 100644 --- a/docs/src/api/README.md +++ b/docs/src/api/README.md @@ -1,2 +1,2 @@ # API -This section gives the documentation for the API. We first give an overview of the API in a language-agnostic way. Afterwards, we continue with the language specific documentation. We recommend to read both to get a complete picture, regardless of the language you're using. +This chapter is an introduction to the eduvpn-common API. It is meant as a high-level overview on how to use API and build your own eduVPN/Let's Connect! client. In this chapter, we *go* over the basics of how the interop between Go and language x works, say something about the architecture, explain where to find detailed API documentation, give a typical flow for a client and give a follow along tutorial on building an eduVPN client using Python code. |