diff --git a/README.md b/README.md new file mode 100644 index 0000000..42a80e7 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Holesail reverse proxy +A CLI for running holesail as a reverse proxy + +# Instalation + +> [!IMPORTANT] +> Make sure you have holesail installed on your system + +Windows: +``` +irm https://raw.githubusercontent.com/CyberL1/holesail-proxy/main/scripts/get.ps1 | iex +``` + +Linux: +``` +curl -fsSL https://raw.githubusercontent.com/CyberL1/holesail-proxy/main/scripts/get.sh | sh +``` + +# Usage + +1. Do `holesail-proxy up` +2. Go to `.localhost` and you'll be connected to the holesail connector after a moment