summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorRanieri Althoff2019-04-30 19:08:11 +0000
committerRanieri Althoff2019-05-11 17:18:24 -0300
commit4fe31ac24962953d8d5324a83c9276de91d17546 (patch)
tree99f4c83fee8341ee2fa87536e3c7e2f4f1587657
parent059663dc618c79dc8e9ee44b22193478af11dcb3 (diff)
downloadaur-4fe31ac24962953d8d5324a83c9276de91d17546.tar.gz
Add README.md
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..66369138bc6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# nordconnect
+A simple shell script to connect to a NordVPN server through OpenVPN.
+
+## Installation
+nordconnect is composed by a single script file, just add it to your path.
+
+### Arch Linux
+If you are on Arch Linux, you can install the [nordconnect AUR package](https://aur.archlinux.org/packages/nordconnect/).
+
+## Usage
+```
+nordconnect [--init | --update | server]
+```
+
+For a detailed list of options, run `nordconnect --help`.
+
+### First use
+Run `nordconnect --init` to initialize nordconnect. It will ask for your username and password.
+
+### Update
+Run `nordconnect --update` to download latest server definitions from NordVPN.
+
+### Examples
+```
+# Just connect to a server
+$ nordconnect us123
+
+# Using nordselect to pick a server
+$ nordconnect $(nordselect us)
+```
+
+## License
+This project is licensed under the [GNU General Public License version 3](https://opensource.org/licenses/GPL-3.0)