Skip to content
This repository has been archived by the owner on Jan 6, 2022. It is now read-only.

Commit

Permalink
Small changes to installation and usage sections
Browse files Browse the repository at this point in the history
  • Loading branch information
chadsr committed Oct 19, 2017
1 parent 62d3591 commit c1d713e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This tool removes the need for manually handling OpenVPN configurations from Nor
More documentation will be available when this tool is out of Alpha releases.

**Warning:**
*This tool is still highly under development and is not yet robust enough to use reliably. I take no responsibility for any unforseen problems it may cause.*
*This tool is still highly under development. I take no responsibility for any unforseen problems it may cause.*

## Features:
- Uses the latest NordVPN OpenVPN configuration files.
Expand All @@ -31,22 +31,30 @@ sudo apt update && sudo apt install openvpn network-manager network-manager-gnom
### Arch

```
sudo pacman -S networkmanager openvpn networkmanager-openvpn
sudo pacman -S --needed networkmanager openvpn networkmanager-openvpn
```

## 2. Installation
**Please note:** This tool requires Python 3.5 or later. (May change in the future)

*If your default Python version is 2.x, you will need to use pip3 below*

### System Install
```
sudo -H pip install nordnm
```

### User Install
```
sudo -H pip3 install nordnm
pip install --user nordnm
```

## 3. Usage
**Note:** Many of the commands below can be chained into one line. A recommended example of this is to update, synchronise and set any auto-connect/kill-switch at the same time.

For example:
```
sudo nordnm -u -s -k -a nl normal tcp
sudo nordnm -uska nl normal tcp
```


Expand Down
23 changes: 17 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ up.
More documentation will be available when this tool is out of Alpha
releases.

**Warning:** *This tool is still highly under development and is not yet
robust enough to use reliably. I take no responsibility for any
unforseen problems it may cause.*
**Warning:** *This tool is still highly under development. I take no
responsibility for any unforseen problems it may cause.*

Features:
---------
Expand Down Expand Up @@ -49,17 +48,29 @@ Arch

::

sudo pacman -S networkmanager openvpn networkmanager-openvpn
sudo pacman -S --needed networkmanager openvpn networkmanager-openvpn

2. Installation
---------------

**Please note:** This tool requires Python 3.5 or later. (May change in
the future)

*If your default Python version is 2.x, you will need to use pip3 below*

System Install
~~~~~~~~~~~~~~

::

sudo -H pip install nordnm

User Install
~~~~~~~~~~~~

::

sudo -H pip3 install nordnm
pip install --user nordnm

3. Usage
--------
Expand All @@ -72,7 +83,7 @@ For example:

::

sudo nordnm -u -s -k -a nl normal tcp
sudo nordnm -uska nl normal tcp

::

Expand Down

0 comments on commit c1d713e

Please sign in to comment.