Changed the README from markdown to just plain text. This will

jkeyes · jkeyes · commit 12bbea086805 · 2012-03-27T23:14:33.000+01:00
allow it to work better as the long description on PyPi. Fixes intercom#4.
diff --git a/README b/README
@@ -0,0 +1,17 @@
+# python-intercom
+
+Python-intercom is a Python wrapper for the Intercom API[1]. 
+Detailed documentation[2] is available on http://readthedocs.org.
+
+Typical usage:
+
+    from intercom import Intercom
+    Intercom.app_id = 'dummy-app-id'
+    Intercom.api_key = 'dummy-api-key'
+    
+    from intercom import User
+    for user in User.all():
+        print user.email
+
+[1] http://docs.intercom.io/api
+[2] http://readthedocs.org/docs/python-intercom/
diff --git a/README.md b/README.md
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,15 @@
+=========
+Changelog
+=========
+
+* 0.2.3
+  * Fixed version number of distribution to match documentation.
+* 0.2.2
+  * Finished docstrings and doctests.
+* 0.2.1
+  * Added some docstrings.
+* 0.2
+  * created source distribution `#2 <https://github.com/jkeyes/python-intercom/issues/2>`_.
+  * renamed errors `#1 <https://github.com/jkeyes/python-intercom/issues/1>`_.
+* 0.1
+  * initial release
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,26 @@
-========
-intercom
-========
+===============
+python-intercom
+===============
 
 .. toctree::
    :hidden:
 
    api/modules
+   installation
+   changelog
 
 Installation
 ============
 
-``pip install python-intercom``
+Stable releases of python-intercom can be installed with 
+`pip <http://pip.openplans.org>`_ or you may download a `.tgz` source 
+archive from `pypi <http://pypi.python.org/pypi/python-intercom#downloads>`_.
+See the :doc:`installation` page for more detailed instructions.
 
-Python wrapper for the Intercom API
+If you want to use the latest code, you can grab it from our 
+`Git repository <http://github.com/jkeyes/python-intercom>`_, or `fork it <http://github.com/jkeyes/python-intercom>`_.
+
+Usage
 ===================================
 
 Authentication
@@ -123,10 +131,16 @@ Reply on a Message Thread
 
     message_thread = MessageThread.create(email="ben@intercom.io",
             thread_id=123,
-            body="No much either :(")
+            body="Not much either :(")
+
+Changelog
+=========
+
+The :doc:`changelog` keeps track of changes per release.
 
 pydoc
 =====
 
 View the extensive `pydoc <api/modules.html>`_ which has liberal helpings of
 `doctests` to display usage.
+
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,29 @@
+============
+Installation
+============
+
+The simplest way to install python-intercom is with `pip <http://pip.openplans.org>`_:
+
+::
+
+    pip install python-intercom
+
+Dependencies
+============
+
+python-intercom uses the `Requests <http://python-requests.org/>`_ HTTP library.
+
+Development Dependencies
+========================
+
+The following packages are used in the development of python-intercom:
+
+* `nose <http://readthedocs.org/docs/nose/en/latest/>`_: makes unit testing easier.
+* `coverage <http://nedbatchelder.com/code/coverage/>`_: code coverage.
+* `mock <http://www.voidspace.org.uk/python/mock/>`_: patching methods for unit testing.
+* `pylint <http://www.logilab.org/857>`_: source code analyzer.
+* `Sphinx <http://sphinx.pocoo.org/>`_: documentation decorator.
+* `Pygments <http://pygments.org/>`_: Python syntax highlighting for documentation.
+* `docutils <http://docutils.sourceforge.net/>`_: reStructuredText support.
+* `Jinja <http://jinja.pocoo.org/docs/>`_: templating language.
+
