From 97ffc5006f21110a85bca17b9103ce20d8f83de2 Mon Sep 17 00:00:00 2001
From: Ralf Schmitt <ralf@systemexit.de>
Date: Tue, 9 Aug 2011 23:28:14 +0200
Subject: [PATCH] add some documentation about configuring easy_install/pip.

---
 README.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.rst b/README.rst
index 5a34c17..2883e4d 100644
--- a/README.rst
+++ b/README.rst
@@ -88,6 +88,34 @@ pypi-server -h will print a detailed usage message::
 
   Visit http://pypi.python.org/pypi/pypiserver for more information.
 
+Configuring pip/easy_install
+============================
+Always specifying the the pypi url on the command line is a bit
+cumbersome. Since pypi-server redirects pip/easy_install to the
+pypi.python.org index if it doesn't have a requested package, it's a
+good idea to configure them to always use your local pypi index.
+
+pip
+~~~~~
+For pip this can be done by setting the environment variable
+PIP_INDEX_URL in your .bashrc/.profile/.zshrc::
+
+  export PIP_INDEX_URL=http://localhost:8080/simple/
+
+or by adding the following lines to ~/.pip/pip.conf::
+
+  [global]
+  index-url = http://localhost:8080/simple/
+
+easy_install
+~~~~~~~~~~~~~
+For easy_install it can be configured with the following setting in
+~/.pydistutils.cfg::
+
+  [easy_install]
+  index_url = http://localhost:8080/simple/
+
+
 
 Optional dependencies
 =====================