add README.rst.

.gitignore

@@ -17,3 +17,4 @@ __pycache__/
 /build/
 /dist/
 /MANIFEST
+/README.html

MANIFEST.in

@@ -1,5 +1,6 @@
 include .gitignore
 include MANIFEST.in
+include README.rst
 include pypi-server
 include pypiserver/__init__.py
 include pypiserver/__main__.py

README.rst

@@ -0,0 +1,32 @@
+.. -*- mode: rst; coding: utf-8 -*-
+
+==============================================================================
+pypiserver - minimal PyPI server for use with pip/easy_install
+==============================================================================
+
+pypiserver is a minimal PyPI compatible server. It can be used to
+serve a set of packages and eggs to easy_install or pip.
+
+Installation and Usage/Quickstart
+=================================
+Run the following commands to get your PyPI server up and running::
+
+  pip install pypiserver
+  mkdir ~/packages
+  # copy some source packages or eggs to this directory
+  pypi-server -p 8080 -r ~/packages
+  pip install -i http://localhost:8080/simple/ ...
+
+
+Optional dependencies
+=====================
+- pypiserver ships with it's own copy of bottle. It's possible to use
+  bottle with different wsgi servers. pypiserver chooses any of the
+  following paste, cherrypy, twisted, wsgiref (part of python) if
+  available.
+
+
+Bugs
+=============
+- pypiserver doesn't support uploading files. One might also consider
+  that a feature. scp provides a nice workaround.

setup.py

@@ -1,5 +1,6 @@
 #! /usr/bin/env python
 
+import os
 from distutils.core import setup
 
 
@@ -12,8 +13,14 @@ def get_version():
     return d["__version__"]
 
 
+def read_long_description():
+    fn = os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.rst")
+    return open(fn).read()
+
+
 setup(name="pypiserver",
       description="minimal pypi server",
+      long_description = read_long_description(),
       version=get_version(),
       packages=["pypiserver"],
       scripts=["pypi-server"],