core
/
ruby-proxifier
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add rationale to README

This commit is contained in:
Samuel Kadolph 2011-06-09 08:44:42 -07:00
parent 1236f339b1
commit bdea638eaa
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -15,6 +15,14 @@ git clone https://github.com/samuelkadolph/ruby-sockets
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
### Environment Variables & Executable Wrappers