Skip to content

Commit

Permalink
more on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nanwu committed Jun 8, 2017
1 parent b3804d7 commit 82445ad
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# Asocks

A SOCKS5 proxy client/server built on of async IO model. It use asyncio librayry
A SOCKS5 proxy client/server built on async IO model. Python3 asyncio library is leveraged for providing high level neworking API.

This project currently is in BETA version with proxy server fully functioning. More features will come soon.
## Installation

pip3 install asocks

## Usage
```
usage:
asocks-server
asocks-server -p 2081
asocks-server -p 2081 -c 1024
asocks-server -p 2081 -c 2014 --local
asocks-server
asocks-server -p 2081
asocks-server -p 2081 -c 1024
asocks-server -p 2081 -c 2014 --local
```

optional arguments:
```
-h, --help show this help message and exit
-p PORT, --port PORT specify port number proxy listens on. Default to port 2080
-c CONCURRENCY, --concurrency CONCURRENCY
Expand Down

0 comments on commit 82445ad

Please sign in to comment.