From 2cf1234534819fd6a66689cdc9a2357266a7497a Mon Sep 17 00:00:00 2001
From: CyberL1 <mateusz.hf18@gmail.com>
Date: Sun, 16 Feb 2025 12:58:33 +0100
Subject: [PATCH] docs: add README for Holesail reverse proxy installation and
 usage

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

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 `<hash>.localhost` and you'll be connected to the holesail connector after a moment