Port README to markdown

Author: srittau

README.md

@@ -0,0 +1,56 @@
+# Python HTML 5 Generator
+
+[![License](https://img.shields.io/pypi/l/htmlgen.svg)](https://pypi.python.org/pypi/htmlgen/)
+[![Release](https://img.shields.io/github/release/srittau/python-htmlgen/all.svg)](https://github.com/srittau/python-htmlgen/releases/)
+[![PyPI](https://img.shields.io/pypi/v/htmlgen.svg)](https://pypi.python.org/pypi/htmlgen/)
+[![Travis CI](https://travis-ci.org/srittau/python-htmlgen.svg?branch=master)](https://travis-ci.org/srittau/python-htmlgen)
+
+Library to generate HTML from classes.
+
+Basic usage:
+
+    >>> from htmlgen import Division, Span
+    >>> Division("This is ", Span("important!"), "!")
+
+A more verbose example:
+
+    >>> span = Span("important")
+    >>> span.add_css_classes("important")
+    >>> div = Division()
+    >>> div.id = "my-block"
+    >>> div.append("This is ")
+    >>> div.append(span)
+    >>> div.append("!")
+
+A tree constructed like this can be converted to a string:
+
+    >>> str(div)
+    '<div id="my-block">This is <span class="important">important</span>!</div>'
+    >>> "<p>This is {}!</p>".format(span)
+    '<p>This is <span class="important">important</span>!</p>'
+
+Alternatively, all elements can be used as iterators, for example to return
+them from a WSGI callback:
+
+    >>> def application(env, start_response):
+    ...     start_response("200 OK", [("Content-Type", "text/html")])
+    ...     return div
+
+There are two different ways to render children of HTML elements. The tree
+construction approach shown above is mainly suitable for elements with few
+children. The disadvantage of this approach is that the whole tree must be
+constructed in memory. An alternative way, best suited for custom sub-classes
+of elements, is to override the generate_children method of the Element class:
+
+    >>> class MyBlock(Division):
+    ...     def __init__(self):
+    ...         super(MyBlock, self).__init__()
+    ...         self.id = "my-block"
+    ...     def generate_children(self):
+    ...         yield "This is "
+    ...         span = Span("important")
+    ...         span.add_css_classes("important")
+    ...         yield span
+    ...         yield "!"
+    >>> str(MyBlock())
+    '<div id="my-block">This is <span class="important">important</span>!</div>'

README.rst

@@ -7,7 +7,8 @@
     name="htmlgen",
     version="2.0.0",
     description="HTML 5 Generator",
-    long_description=open("README.rst").read(),
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
     author="Sebastian Rittau",
     author_email="[email protected]",
     url="https://github.com/srittau/python-htmlgen",