From e2b60291020cc86c86c414a34f83fccfd7fcae56 Mon Sep 17 00:00:00 2001 From: xzeldon Date: Tue, 31 Oct 2023 08:00:29 +0300 Subject: [PATCH] docs(README.md): Update usage, proxy server instructions & license info --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4b1e948..bda92e6 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,48 @@ This is a lightweight proxy server written in Go that supports HTTP requests and - Customizable port, username, and password using command-line arguments - Logging -## Requirements +## Prerequisites -- Go (version 1.x+) +- Golang (if building from source) ## Usage -### Running the Proxy from source +### Running the Proxy + +#### For Darwin/Linux: + +1. Download the latest release for your platform from GitHub releases +2. Extract the downloaded archive: + + ```bash + tar -xvzf http-proxy-server-v{version}-{platform}-{arch}.tar.gz + ``` + +3. Navigate to the extracted folder: + + ```bash + cd http-proxy-server-v{version}-{platform}-{arch} + ``` + +4. Run the proxy: + + ```bash + ./http-proxy-server --port [--username --password ] + ``` + +#### For Windows: + +1. Download the latest release for Windows from GitHub releases +2. Extract the downloaded ZIP archive +3. Navigate to the extracted folder. +4. Open a command prompt in this directory. +5. Run the proxy: + + ```bash + proxy_name.exe --port [--username --password ] + ``` + +#### From Source 1. Clone the repository: ```bash @@ -45,4 +80,8 @@ go run main.go --port 1489 --username admin --password admin123 ### Authentication -If you specify both `--username` and `--password` when starting the proxy, it will enforce Basic Proxy Authentication with the given credentials. If these parameters are omitted, the proxy will not require authentication. \ No newline at end of file +If you specify both `--username` and `--password` when starting the proxy, it will enforce Basic Proxy Authentication with the given credentials. If these parameters are omitted, the proxy will not require authentication. + +### License + +This project is licensed under the MIT License. \ No newline at end of file