Convert README to Markdown

Author: srittau

README.rst README.mdREADME.rst renamed to README.md

@@ -1,49 +1,47 @@
 Python Asserts
 ==============
 
-.. image:: https://img.shields.io/pypi/l/asserts.svg
-   :target: https://pypi.python.org/pypi/asserts/
-.. image:: https://img.shields.io/github/release/srittau/python-asserts/all.svg
-   :target: https://github.com/srittau/python-asserts/releases/
-.. image:: https://img.shields.io/pypi/v/asserts.svg
-   :target: https://pypi.python.org/pypi/asserts/
-.. image:: https://travis-ci.org/srittau/python-asserts.svg?branch=master
-   :target: https://travis-ci.org/srittau/python-asserts
+[![License](https://img.shields.io/pypi/l/asserts.svg)](https://pypi.python.org/pypi/asserts/)
+[![GitHub](https://img.shields.io/github/release/srittau/python-asserts/all.svg)](https://github.com/srittau/python-asserts/releases/)
+[![pypi](https://img.shields.io/pypi/v/asserts.svg)](https://pypi.python.org/pypi/asserts/)
+[![Travis CI](https://travis-ci.org/srittau/python-asserts.svg?branch=master)](https://travis-ci.org/srittau/python-asserts)
 
 Stand-alone Assertions for Python
 
 This package provides a few advantages over the assertions provided by
 unittest.TestCase:
 
 * Can be used stand-alone, for example:
-
-  * In test cases, not derived from TestCase.
-  * In fake and mock classes.
-  * In implementations as rich alternative to the assert statement.
-
+    * In test cases, not derived from TestCase.
+    * In fake and mock classes.
+    * In implementations as rich alternative to the assert statement.
 * PEP 8 compliance.
 * Custom stand-alone assertions can be written easily.
 * Arguably a better separation of concerns, since TestCase is responsible
   for test running only, if assertion functions are used exclusively.
 
 There are a few regressions compared to assertions from TestCase:
 
-* The default assertion class (AssertionError) can not be overwritten. This
+* The default assertion class (`AssertionError`) can not be overwritten. This
   is rarely a problem in practice.
-* asserts does not support the addTypeEqualityFunc() functionality.
+* asserts does not support the `addTypeEqualityFunc()` functionality.
 
 Usage:
 
+```python
 >>> from asserts import assert_true, assert_equal, assert_raises
 >>> my_var = 13
 >>> assert_equal(13, my_var)
 >>> assert_true(True, msg="custom failure message")
 >>> with assert_raises(KeyError):
 ...     raise KeyError()
+```
 
 Failure messages can be customized:
 
+```python
 >>> assert_equal(13, 14, msg_fmt="{got} is wrong, expected {expected}")
 Traceback (most recent call last):
   ...
 AssertionError: 14 is wrong, expected 13
+```

setup.py

@@ -12,7 +12,8 @@ def read(fname):
     name="asserts",
     version="0.10.0",
     description="Stand-alone Assertions",
-    long_description=read("README.rst"),
+    long_description=read("README.md"),
+    long_description_content_type="text/markdown",
     author="Sebastian Rittau",
     author_email="srittau@rittau.biz",
     url="https://github.com/srittau/python-asserts",