diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-13 12:12:22 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-13 12:12:22 +0200 |
| commit | 5abf00ab87a55662eefc7716de52ead9749293c6 (patch) | |
| tree | 1cfa64b99482d7cc08b1d7da5d6833b75f5f7714 /docs/src/about.md | |
| parent | 57d6c2ac55a5fd1ea609c873d5410174b7cf6ca4 (diff) | |
Refactor: Adapt the API to the documentation
Diffstat (limited to 'docs/src/about.md')
| -rw-r--r-- | docs/src/about.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/src/about.md b/docs/src/about.md index e2715c0..672ae6a 100644 --- a/docs/src/about.md +++ b/docs/src/about.md @@ -1,8 +1,8 @@ # About This chapter contains background information for the library. We give a general introduction to eduVPN and explain what problems this library aims to solve. -## eduVPN introduction -eduVPN-common is a library for [eduVPN](https://www.eduvpn.org/), which is a VPN by [Surf](https://www.surf.nl) for research institutions such as Universities. Each institution that uses eduVPN has its own server. To discover these servers and establish a VPN connection with them, eduVPN clients are used. eduVPN has clients for each common platform: +## EduVPN introduction +eduVPN-common is a library for [eduVPN](https://www.eduvpn.org/), which is a VPN by [SURF](https://www.surf.nl) and a project by [GÉANT](https://geant.org/), for research institutes such as Universities. Each institute that uses eduVPN has its own server. To discover these servers and establish a VPN connection with them, eduVPN clients are used. eduVPN has clients for each common platform: - [Android](https://github.com/eduvpn/android) - [Linux](https://github.com/eduvpn/python-eduvpn-client) - [MacOS/iOS](https://github.com/eduvpn/apple) @@ -12,8 +12,13 @@ eduVPN-common is a library for [eduVPN](https://www.eduvpn.org/), which is a VPN However, as these clients are rather similar in functionality, apart from platform specific differences, right now there is duplicate code between them. For example, the process to discover institution's servers, the authorization process (OAuth) and Wireguard key generation. This goal of this library is to provide the common functionality between these clients into one codebase. The library is written in the [Go](https://go.dev/) language and has wrapper code for each of the languages that are used by the current clients. +The main goal is thus the following: + + +This library tries to remove non-platform specific common functionality. This way eduVPN clients have less duplicate code. + ## License [MIT](https://github.com/jwijenbergh/eduvpn-common/blob/main/LICENSE) ## Authors -This library is written by [Steven Wallis de Vries](https://github.com/stevenwdv) and [Jeroen Wijenbergh](https://github.com/jwijenbergh), two Radboud University students that worked at Surf for their research internship. +This library is written by [Steven Wallis de Vries](https://github.com/stevenwdv) and [Jeroen Wijenbergh](https://github.com/jwijenbergh), two Radboud University students that worked at SURF for their research internship. |