Markdown readme

README.md

@@ -0,0 +1,57 @@
+# pymlconf
+
+[![PyPI](http://img.shields.io/pypi/v/pymlconf.svg)](https://pypi.python.org/pypi/pymlconf)
+[![Build](https://github.com/pylover/pymlconf/workflows/Build/badge.svg?branch=master)](https://github.com/pylover/pymlconf/actions)
+[![Coverage Status](https://coveralls.io/repos/github/pylover/pymlconf/badge.svg?branch=master)](https://coveralls.io/github/pylover/pymlconf?branch=master)
+[![Documentation](https://img.shields.io/badge/Documentation-green)](https://pylover.github.io/pymlconf)
+
+
+## About
+
+`pymlconf` (Python YAML Configuration Library) helps to easily manage
+and access to your application configurations which was already Written
+in [YAML](http://pyyaml.org) language.
+
+Checkout [Documentation](https://pylover.github.io/pymlconf) for more info.
+
+
+### Installation
+
+
+```bash
+pip install pymlconf
+```
+
+### Development
+
+```bash
+cd path/to/pymlconf
+pip install -e .
+pip install -r requirements-dev.txt
+```
+
+#### Running tests
+
+```bash
+pytest
+```
+
+#### Coverage
+
+```bash
+pytest --cov=pymlconf
+```
+
+#### Documentation
+
+```bash
+cd sphinx
+make doctest
+```
+
+```bash
+make html
+or
+make livehtml
+```
+

setup.py

@@ -30,10 +30,11 @@ def read(filename):
     author_email="vahid.mardani@gmail.com",
     url="http://github.com/pylover/pymlconf",
     description="Another configuration library using yaml",
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',  # This is important!
     packages=find_packages(),
     package_data={'pymlconf': ['tests/conf/*', 'tests/files/*']},
     platforms=["any"],
-    long_description=read('README.rst'),
     install_requires=dependencies,
     classifiers=[
         "Development Status :: 5 - Production/Stable",