Added a README
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..1f072e4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,35 @@
+.. image:: https://travis-ci.org/agronholm/pythonfutures.svg?branch=master
+ :target: https://travis-ci.org/agronholm/pythonfutures
+ :alt: Build Status
+
+This is a backport of the `concurrent.futures`_ standard library module to Python 2.
+
+It should not be installed on Python 3, although there should be no harm in doing so, as the
+standard library takes precedence over third party libraries.
+
+To conditionally require this library only on Python 2, you can do this in your ``setup.py``:
+
+.. code-block:: python
+
+ setup(
+ ...
+ extras_require={
+ ':python_version == "2.7"': ['futures']
+ }
+ )
+
+Or, using the newer syntax:
+
+.. code-block:: python
+
+ setup(
+ ...
+ install_requires={
+ 'futures; python_version == "2.7"'
+ }
+ )
+
+.. warning:: The ``ProcessPoolExecutor`` class has known (unfixable) problems on Python 2 and
+ should not be relied on for mission critical work.
+
+.. _concurrent.futures: https://docs.python.org/library/concurrent.futures.html
diff --git a/setup.py b/setup.py
index eb43091..5d947ae 100755
--- a/setup.py
+++ b/setup.py
@@ -1,5 +1,6 @@
#!/usr/bin/env python
from warnings import warn
+import os.path
import sys
if sys.version_info[0] > 2:
@@ -14,9 +15,14 @@
except ImportError:
from distutils.core import setup
+here = os.path.dirname(__file__)
+with open(os.path.join(here, 'README.rst')) as f:
+ readme = f.read()
+
setup(name='futures',
version='3.1.1',
description='Backport of the concurrent.futures package from Python 3.2',
+ long_description=readme,
author='Brian Quinlan',
author_email='[email protected]',
maintainer='Alex Gronholm',
