From 301b3f7c732882b786c815182cb80ef80f2b1212 Mon Sep 17 00:00:00 2001 From: ishan dutta Date: Sun, 30 Jun 2019 12:11:43 +0530 Subject: [PATCH] made Readme more readable --- README.md | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 8de663a..b2280f0 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,27 @@ # 3APA3A 3proxy tiny proxy server (c) 2002-2019 by Vladimir '3APA3A' Dubrovin <3proxy@3proxy.ru> -Download: + +## Download: https://github.com/z3APA3A/3proxy/releases or https://3proxy.org/download/ Archive of old versions: https://github.com/z3APA3A/3proxy-archive +## Setup -3proxy --install +`3proxy --install` - installs and starts proxy as Windows service - (config file should be located in the same directory) +installs and starts proxy as Windows service +(config file should be located in the same directory) -3proxy --remove - removes the service (should be stopped before via - 'net stop 3proxy'). +`3proxy --remove` - To build in Linux install git and build-essential packages, use +removes the service (should be stopped before via +'net stop 3proxy'). + +To build in Linux install git and build-essential packages, use git clone https://github.com/z3apa3a/3proxy cd 3proxy @@ -26,12 +29,14 @@ ln -s Makefile.Linux Makefile make sudo make install - use /etc/3proxy/add3proxyuser.sh script to add users. +use /etc/3proxy/add3proxyuser.sh script to add users. + Please read doc/html/index.html and man pages. - Features: + +## Features: 1. General + IPv6 support for incoming and outgoing connection, can be used as a proxy between IPv4 and IPv6 networks @@ -188,6 +193,10 @@ dighosts Utility for building networks list from web page. Run utility with --help option for command line reference. -Latest version is available from https://3proxy.org/ -Want to donate the project? https://3proxy.org/donations/ +## Latest version is available from : +https://3proxy.org/ + + +## Want to donate the project? +https://3proxy.org/donations/