From 18ea254f50a8ada0276dcdc086a51d6210db989f Mon Sep 17 00:00:00 2001 From: Robbie Cahill Date: Mon, 4 Dec 2023 20:20:12 +1100 Subject: [PATCH] Update binary install instructions --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index dfdb2e9..33aefd9 100644 --- a/README.md +++ b/README.md @@ -37,21 +37,20 @@ If you have **NodeJS 16.10** or later, you can install Tunnelmole by running sudo npm install -g tunnelmole ``` -Alternatively you can install the latest precompiled binary for your platform. This has the right version of Node built in. You don't need any specific version of Node installed for this approach. -#### Linux -Copy and paste the following into a terminal -``` -curl -s https://tunnelmole.com/sh/install-linux.sh | sudo bash -``` +Alternatively, you can install a pre-built binary for your platform -#### Mac -Copy and paste the following into a terminal +#### Linux, Mac and Windows Subsystem for Linux +Copy and paste the following into a terminal: ``` - curl -s https://tunnelmole.com/sh/install-mac.sh --output install-mac.sh && sudo bash install-mac.sh +curl -O https://tunnelmole.com/sh/install.sh && sudo bash install.sh ``` +The script will detect your OS and install the right version. #### Windows -Download the `exe` file for Windows [here](https://tunnelmole.com/downloads/tmole.exe) and put it somewhere in your PATH. +1. [Download tmole.exe](https://tunnelmole.com/downloads/tmole.exe) +2. Put it somewhere in your [PATH](https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows). + +I'd like to have the install script for Linux and Mac also working in Cygwin and Mingw. Let me know if you're willing to help test!. #### Build the binaries yourself The above binaries are generated with a combination of [pkg](https://github.com/vercel/pkg) and [rollup](https://github.com/rollup/rollup).