From bdea638eaa0008a5a7c41e907c5a7df25ebe66f7 Mon Sep 17 00:00:00 2001 From: Samuel Kadolph Date: Thu, 9 Jun 2011 08:44:42 -0700 Subject: [PATCH] Add rationale to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 3587a7e..f1eac2f 100644 --- a/README.md +++ b/README.md @@ -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