Add readme

This commit is contained in:
Melon 2021-04-29 17:36:42 +01:00
parent baf7d64cab
commit b911ab6cf7

19
README.md Normal file
View File

@ -0,0 +1,19 @@
Melon VPN
=========
Client for MrMelon's VPN server.
## Downloads
- Debian: Available from https://apt.onpointcoding.net/repo
- Windows: in development
- MacOS: Maybe the linux source code works on Mac but I don't have a Mac to test it?
## Debian packages
- melonvpn: contains the cli and daemon
- simple-vpn: the vpn client used internally by the daemon
- melonvpngui: contains the gui extension library
- melonvpn: the gui requires the main package to function
- libappindicator3-1: used by the gui to display an app indicator