# HG changeset patch
# User Jeff Hammel <jhammel@mozilla.com>
# Date 1330734305 28800
# Node ID f42df14565651ff1122c893a1b0c696f8141f16c
# Parent  d5c3fdceb718a003a801e0078b0152630d968489
add a giant example section

diff -r d5c3fdceb718 -r f42df1456565 README.txt
--- a/README.txt	Fri Mar 02 16:23:36 2012 -0800
+++ b/README.txt	Fri Mar 02 16:25:05 2012 -0800
@@ -32,6 +32,97 @@
 Currently ``simpypi`` only works on source distributions (that is,
 packages made with ``python setup.py sdist``).
 
+Example
+-------
+
+I installed an instance of ``simpypi`` at http://k0s.org:8080 for
+demonstration purposes with a package index at http://k0s.org:8080/index/ .
+For testing purposes, I made a script,
+`upload_mobase.py <http://k0s.org/mozilla/hg/simpypi/file/tip/tests/upload_mozbase.py>`_
+that uploads the
+`mozbase <https://github.com/mozilla/mozbase>`_ packages to
+``simpypi``.  So the
+`index <http://k0s.org:8080/index/>`_ is now populated with them.
+
+You can upload packages with
+`curl <http://www.cs.sunysb.edu/documentation/curl/>`_ ::
+
+    > wget http://pypi.python.org/packages/source/P/PyYAML/PyYAML-3.10.tar.gz
+    > curl -F 'package=@PyYAML-3.10.tar.gz' http://k0s.org:8080/
+
+You can ``easy_install`` mozbase from http://k0s.org:8080/index/ .
+If a package's dependencies can be found from the ``simpypi`` package
+index, they will also be installed from the index::
+
+    > virtualenv.py tmp
+    New python executable in tmp/bin/python
+    Installing setuptools............done.
+    Installing pip...............done.
+    > cd tmp/
+    (tmp)│easy_install -i http://k0s.org:8080/index/ mozrunner
+    Searching for mozrunner
+    Reading http://k0s.org:8080/index/mozrunner/
+    Best match: mozrunner 5.1
+    Downloading http://k0s.org:8080/index/mozrunner/mozrunner-5.1.tar.gz
+    Processing mozrunner-5.1.tar.gz
+    Running mozrunner-5.1/setup.py -q bdist_egg --dist-dir
+    /tmp/easy_install-gqerOV/mozrunner-5.1/egg-dist-tmp-Qyx3Cr
+    Adding mozrunner 5.1 to easy-install.pth file
+    Installing mozrunner script to /home/jhammel/tmp/bin
+    Installed
+    /home/jhammel/tmp/lib/python2.7/site-packages/mozrunner-5.1-py2.7.egg
+    Processing dependencies for mozrunner
+    Searching for mozprofile>=0.1
+    Reading http://k0s.org:8080/index/mozprofile/
+    Best match: mozprofile 0.1
+    Downloading http://k0s.org:8080/index/mozprofile/mozprofile-0.1.tar.gz
+    Processing mozprofile-0.1.tar.gz
+    Running mozprofile-0.1/setup.py -q bdist_egg --dist-dir
+    /tmp/easy_install-4Im6x0/mozprofile-0.1/egg-dist-tmp-9Jp5TR
+    Adding mozprofile 0.1 to easy-install.pth file
+    Installing mozprofile script to /home/jhammel/tmp/bin
+    Installed
+    /home/jhammel/tmp/lib/python2.7/site-packages/mozprofile-0.1-py2.7.egg
+    Searching for mozprocess
+    Reading http://k0s.org:8080/index/mozprocess/
+    Best match: mozprocess 0.1b2
+    Downloading
+    http://k0s.org:8080/index/mozprocess/mozprocess-0.1b2.tar.gz
+    Processing mozprocess-0.1b2.tar.gz
+    Running mozprocess-0.1b2/setup.py -q bdist_egg --dist-dir
+    /tmp/easy_install-KU6AiF/mozprocess-0.1b2/egg-dist-tmp-4j5CMP
+    Adding mozprocess 0.1b2 to easy-install.pth file
+    Installed
+    /home/jhammel/tmp/lib/python2.7/site-packages/mozprocess-0.1b2-py2.7.egg
+    Searching for mozinfo
+    Reading http://k0s.org:8080/index/mozinfo/
+    Best match: mozinfo 0.3.3
+    Downloading http://k0s.org:8080/index/mozinfo/mozinfo-0.3.3.tar.gz
+    Processing mozinfo-0.3.3.tar.gz
+    Running mozinfo-0.3.3/setup.py -q bdist_egg --dist-dir
+    /tmp/easy_install-JaKeaz/mozinfo-0.3.3/egg-dist-tmp-xWojez
+    Adding mozinfo 0.3.3 to easy-install.pth file
+    Installing mozinfo script to /home/jhammel/tmp/bin
+    Installed
+    /home/jhammel/tmp/lib/python2.7/site-packages/mozinfo-0.3.3-py2.7.egg
+    Searching for ManifestDestiny>=0.5.4
+    Reading http://k0s.org:8080/index/ManifestDestiny/
+    Best match: ManifestDestiny 0.5.4
+    Downloading
+    http://k0s.org:8080/index/ManifestDestiny/ManifestDestiny-0.5.4.tar.gz
+    Processing ManifestDestiny-0.5.4.tar.gz
+    Running ManifestDestiny-0.5.4/setup.py -q bdist_egg --dist-dir
+    /tmp/easy_install-2blF3S/ManifestDestiny-0.5.4/egg-dist-tmp-R3KZde
+    Adding ManifestDestiny 0.5.4 to easy-install.pth file
+    Installing manifestparser script to /home/jhammel/tmp/bin
+    Installed
+    /home/jhammel/tmp/lib/python2.7/site-packages/ManifestDestiny-0.5.4-py2.7.egg
+    Finished processing dependencies for mozrunner
+
+Note that all of the packages come from the k0s.org installation and
+not from http://pypi.python.org/ .
+
+
 Running the Tests
 -----------------