diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/README.md b/README.md index 12537814ea5e..642ab93b582e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,36 @@ ## Windscribe VPN CLI for Arch Linux -**Update: You can now install this package from AUR: k** +**Update: You can now install this package from [AUR](https://aur.archlinux.org/packages/windscribe-cli/)** ### Overview This repository contains the files necessary to build Windscribe VPN CLI for Arch Linux. Currently, Windscribe's CLI is in open beta, so users should anticipate breakages. -### Installing -In order the install Windscribe's CLI, use the following instructions: +### Installation + +#### Installing From AUR +- You install this package from the Arch User Repository (AUR) by using `yaourt` and running `yaourt -S windscribe-cli`. + +#### Installing From Source +In order the install Windscribe's CLI from source, use the following instructions: 1. Clone this repository onto your local machine. 2. `cd` into the cloned repository. 3. Execute `makepkg -cs` to build the package. -4. After the build process is finished, run `sudo pacman -U windscribe-cli-1.0-1-any.pkg.tar` to install the package. -5. Close out of any active terminals (this is so that bash autocomplete works) -6. Make sure that the windscribe daemon is running: `systemctl status windscribe.service` -7. Now running `windscribe` in your terminal should bring-up the CLI +4. After the build process is finished, run `sudo pacman -U windscribe-cli-1.1-1-[PACKAGE ARCHITECTURE].pkg.tar` to install the +package. + +### Running Windscribe CLI +1. After installing for the first time, close out of any active terminals (this is so that bash autocomplete works) +2. Check to see if the windscribe daemon is running: `systemctl status windscribe.service` +3. If the daemon is not running, you can simply run `sudo systemctl start windscribe`. (If you want the daemon to automatically start on boot, you can run `sudo systemctl enable windscribe`, otherwise you will have to execute `sudo systemctl start windscribe` every time the computer is booted) +4. Now running `windscribe` in your terminal should bring-up the CLI +5. To login to windscribe, run `windscribe login` +6. To connect to windscribe, run `windscribe connect` +7. If you need additional help, run `windscribe --help`  ### Resources [Windscribe](https://windscribe.com/) -[Windscribe Linux Download](https://windscribe.com/guides/linux)
\ No newline at end of file +[Windscribe Linux Download](https://windscribe.com/guides/linux) |