Edit the README

MANIFEST.in

@@ -1 +1 @@
-include README.rst
+include README.markdown

README.markdown

@@ -0,0 +1,99 @@
+[![Build Status](https://travis-ci.org/ckan/datapusher.png?branch=master)](https://travis-ci.org/ckan/datapusher)
+[![Coverage Status](https://coveralls.io/repos/ckan/datapusher.png?branch=master)](https://coveralls.io/r/ckan/datapusher?branch=master)
+[![Latest Version](https://pypip.in/version/datapusher/badge.svg)](https://pypi.python.org/pypi/datapusher/)
+[![Downloads](https://pypip.in/download/datapusher/badge.svg)](https://pypi.python.org/pypi/datapusher/)
+[![Supported Python versions](https://pypip.in/py_versions/datapusher/badge.svg)](https://pypi.python.org/pypi/datapusher/)
+[![Development Status](https://pypip.in/status/datapusher/badge.svg)](https://pypi.python.org/pypi/datapusher/)
+[![License](https://pypip.in/license/datapusher/badge.svg)](https://pypi.python.org/pypi/datapusher/)
+
+[PyPI]: https://pypi.python.org/pypi/datapusher
+[DataStorer]: https://github.com/ckan/ckanext-datastorer
+[DataPusher documentation]: http://docs.ckan.org/projects/datapusher
+[CKAN Service Provider]: https://github.com/ckan/ckan-service-provider
+[Messytables]: https://github.com/okfn/messytables
+
+
+DataPusher - Automatically add Data to the CKAN DataStore
+=========================================================
+
+DataPusher is a standalone web service that automatically downloads any CSV or
+XLS (Excel) data files from a CKAN site's resources when they are added to the
+CKAN site, parses them to pull out the actual data, then uses the DataStore API
+to push the data into the CKAN site's DataStore.
+
+This makes the data from the resource files available via CKAN's DataStore API.
+In particular, many of CKAN's data preview and visualization plugins will only
+work (or will work much better) with files whose contents are in the DataStore.
+
+To get it working you have to:
+
+1. Deploy a DataPusher instance to a server (or use an existing DataPusher
+   instance)
+2. Enable and configure the `datastore` plugin on your CKAN site.
+3. Enable and configure the `datapusher` plugin on your CKAN site.
+
+For details see the [DataPusher documentation][].
+
+Note that if you installed CKAN using the _package install_ option then a
+DataPusher instance should be automatically installed and configured to work
+with your CKAN site.
+
+DataPusher is a replacement for [DataStorer][].
+It's built using [CKAN Service Provider][] and [Messytables][].
+
+The original author of DataPusher was
+Dominik Moritz <[email protected]>. For the current list of contributors
+see [github.com/ckan/datapusher/contributors](https://github.com/ckan/datapusher/contributors)
+
+
+## Development
+
+To install DataPusher for development:
+
+```bash
+git clone https://github.com/ckan/datapusher.git
+cd datapusher
+pip install -r requirements-dev.txt
+```
+
+To run the tests:
+
+```bash
+nosetests
+```
+
+To build the documentation:
+
+```bash
+python setup.py build_sphinx
+```
+
+## Releasing a New Version
+
+To release a new version of DataPusher:
+
+1. Increment the version number in [setup.py](setup.py)
+
+2. Build a source distribution of the new version and publish it to
+   [PyPI][]:
+
+   ```bash
+   python setup.py sdist
+   python setup.py sdist upload
+   ```
+
+   You may want to test installing and running the new version from PyPI in a
+   clean virtualenv before continuing to the next step.
+
+3. Commit your setup.py changes to git, tag the release, and push the changes
+   and the tag to GitHub:
+
+   ```bash
+   git commit setup.py -m "Bump version number"
+   git tag 0.0.1
+   git push
+   git push origin 0.0.1
+   ```
+
+   (Replace both instances of 0.0.1 with the number of the version you're
+   releasing.)

setup.py

@@ -5,7 +5,7 @@
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the relevant file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, 'README.markdown'), encoding='utf-8') as f:
     long_description = f.read()
 
 setup(