Adding doc for proxy support.

hub-cap · hub-cap · commit a8eaab95de60 · 2011-05-19T15:41:47.000-05:00
diff --git a/AUTHORS b/AUTHORS
@@ -23,4 +23,4 @@ Barthelemy Dagenais <bart@cs.mcgill.ca>
 Surajram Kumarave <root@surajram.com>
 broderboy <timothy.broder@gmail.com>
 Patryk Zawadzki <patrys@pld-linux.org>
-hub-cap <mbasnight@gmail.com>
+Michael Basnight <mbasnight@gmail.com>
diff --git a/doc/api/client.rst b/doc/api/client.rst
@@ -41,3 +41,13 @@ in::
     >>> from github2.client import Github
     >>> github = Github(username="ask", api_token=".......",
     ...                 requests_per_second=1)
+
+If you wish to use the library with a HTTP proxy, you will require a Python
+SOCKS module installed.  :pypi:`SocksiPy-branch` is the module we test with, but
+various forks are available.  Pass in the ``proxy_host`` and optionally
+``proxy_port`` settings to enable it.  The default for ``proxy_port``, if not
+given, is 8080::
+
+    >>> from github2.client import Github
+    >>> github = Github(username="ask", api_token=".......",
+    ...                 proxy_host="my.proxy.com", proxy_port=9000)
