commit 7b027075daa43011f1bac23aeaa0a7f852cfe153 Author: q3aql Date: Sat May 28 18:40:16 2022 +0200 README.md (v2.0) diff --git a/README.md b/README.md new file mode 100644 index 0000000..2e9ae91 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +dmenu_protonvpn - Dmenu script tool for manage your ProtonVPN connections +========================================================================= + +# Dependencies: + + * gcc + * make + * openvpn + * coreutils + * sed + * zenity `(Opcional)` + * kitty `(Opcional)` + * xterm + * bash + * freetype2-devel + * expat-devel + +### Build and install: + +* Open terminal and run the following commands: + + ```shell + $ git clone https://github.com/q3aql/dmenu_protonvpn + $ sudo make install clean + ```` + +### How to use: + +* Open terminal and type the following command as root: + + ```shell + dmenu_protonvpn + ``` + +* NOTE: You can also use the applications menu: `Menu > Network > Dmenu_ProtonVPN` + + + +### How to use (CLI): + +* Open terminal and type the following command as root: + + ```shell + dmenu_protonvpn_cli + ``` + + + +### External links: + + * [ProtonVPN homepage](https://protonvpn.com/) + * [OpenVPN homepage](https://openvpn.net/) + * [OpenVPN Community](https://openvpn.net/community-downloads/) + * [Zenity homepage](https://wiki.gnome.org/Projects/Zenity) + + +