Add rationale to README
This commit is contained in:
parent
1236f339b1
commit
bdea638eaa
|
@ -15,6 +15,14 @@ git clone https://github.com/samuelkadolph/ruby-sockets
|
||||||
cd ruby-sockets && rake install
|
cd ruby-sockets && rake install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
This gem was created for 2 purposes.
|
||||||
|
|
||||||
|
First is to enable ruby programmers to use HTTP or SOCKS proxies interchangeably when using TCPSockets. Either manually with `Sockets::Proxy#open` or by `require "sockets/env"`.
|
||||||
|
|
||||||
|
The second purpose is use ruby code that doesn't consider a proxy for users that have to use proxies. The pruby and pirb executables are simple wrappers for their respective ruby executables that support proxies from environment variables.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Environment Variables & Executable Wrappers
|
### Environment Variables & Executable Wrappers
|
||||||
|
|
Loading…
Reference in New Issue