Skip to content

Commit 4d19cb2

Browse files
author
Alexandru Cheltuitor
committed
Update repo documentation: contributing, copying and updated readme
1 parent 470f989 commit 4d19cb2

File tree

3 files changed

+44
-4
lines changed

3 files changed

+44
-4
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contribution Policy
2+
3+
By making a contribution to this project:
4+
5+
1. I assign any and all copyright related to the contribution to Proton Technologies AG;
6+
2. I certify that the contribution was created in whole by me;
7+
3. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely and may be redistributed with this project or the open source license(s) involved.

COPYING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Copying
2+
3+
Copyright (c) 2021 Proton Technologies AG
4+
5+
ProtonVPN Linux CLI is free software: you can redistribute it and/or modify
6+
it under the terms of the GNU General Public License as published by
7+
the Free Software Foundation, either version 3 of the License, or
8+
(at your option) any later version.
9+
10+
ProtonVPN Linux CLI is distributed in the hope that it will be useful,
11+
but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
GNU General Public License for more details.
14+
15+
You should have received a copy of the GNU General Public License
16+
along with ProtonVPN. If not, see [https://www.gnu.org/licenses](https://www.gnu.org/licenses/).

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1-
# ProtonVPNCLI
1+
# ProtonVPN Linux CLI
22

3-
Official ProtonVPN CLI for Linux based systems.
3+
Copyright (c) 2021 Proton Technologies AG
4+
5+
This repository holds the ProtonVPN Linux CLI.
6+
For licensing information see [COPYING](COPYING.md).
7+
For contribution policy see [CONTRIBUTING](CONTRIBUTING.md).
8+
9+
## Description
10+
The [ProtonVPN](https://protonvpn.com) Linux CLI is intended for every ProtonVPN service user.
11+
12+
You can download the latest stable release, either from our official repositories or directly on the [official GitHub repository](https://github.com/ProtonVPN/linux-cli/releases/latest).
413

514
### Dependencies:
15+
| **Distro** | **Command** |
16+
|:----------------------------------------|:----------------------------------------------------------------------------------------------------------------|
17+
|Fedora/CentOS/RHEL | `python3-dialog` |
18+
|Ubuntu/Linux Mint/Debian and derivatives | `python3-dialog` |
19+
|Arch Linux/Manjaro | `python-pythondialog` |
620

7-
python3-protonvpn-nm-lib, python3-dialog
21+
### Additional dependency:
22+
[ProtonVPN NM Library](https://github.com/ProtonVPN/protonvpn-nm-lib)
823

24+
## Installation
25+
Follow our [knowledge base article](to-add) on how to install the CLI on your system.
926

1027
## How to use
1128

@@ -22,7 +39,7 @@ python3-protonvpn-nm-lib, python3-dialog
2239
|`protonvpn-cli c --sc` | Connect to fastest Secure Core server. |
2340
|`protonvpn-cli disconnect, d` | Disconnect from VPN session. |
2441
|`protonvpn-cli s, status` | Display VPN session status. |
25-
|`protonvpn-cli config` | Change user settings menu. |
42+
|`protonvpn-cli config` | Change user settings. |
2643
|`protonvpn-cli ks, killswitch` | Change kill switch settings. |
2744
|`protonvpn-cli --version` | Display version. |
2845
|`protonvpn-cli --help` | Show help message. |

0 commit comments

Comments
 (0)