Create README.md (#32)

* Create README.md
* Update setup.py
* Delete README.rst

Author: gkorland

README.rst renamed to README.md

@@ -1,47 +1,31 @@
-RedisJSON Python Client
-====================
+[![license](https://img.shields.io/github/license/RedisJSON/RedisJSON-py.svg)](https://github.com/RedisJSON/redisjson-py/blob/master/LICENSE)
+[![CircleCI](https://circleci.com/gh/RedisJSON/redisjson-py/tree/master.svg?style=svg)](https://circleci.com/gh/RedisJSON/redisjson-py/tree/master)
+[![pypi](https://badge.fury.io/py/rejson.svg)](https://badge.fury.io/py/rejson)
+[![PyVersions](https://img.shields.io/pypi/pyversions/rejson.svg)](https://github.com/RedisJSON/redisjson-py)
+[![GitHub issues](https://img.shields.io/github/release/RedisJSON/redisjson-py.svg)](https://github.com/RedisJSON/redisjson-py/releases/latest)
+[![Codecov](https://coveralls.io/repos/github/RedisLabs/rejson-py/badge.svg?branch=master)](https://coveralls.io/github/RedisLabs/rejson-py?branch=master)
 
-.. image:: https://img.shields.io/github/license/RedisJSON/RedisJSON-py.svg
-    :target: https://github.com/RedisJSON/redisjson-py/blob/master/LICENSE
-    
-.. image:: https://circleci.com/gh/RedisJSON/redisjson-py/tree/master.svg?style=svg
-    :target: https://circleci.com/gh/RedisJSON/redisjson-py/tree/master
-
-.. image:: https://badge.fury.io/py/rejson.svg
-    :target: https://badge.fury.io/py/rejson
-
-.. image:: https://img.shields.io/pypi/pyversions/rejson.svg
-    :target: https://github.com/RedisJSON/redisjson-py
-    
-.. image:: https://img.shields.io/github/release/RedisJSON/redisjson-py.svg
-    :target: https://github.com/RedisJSON/redisjson-py/releases/latest
+# RedisJSON Python Client
 
-.. image:: https://coveralls.io/repos/github/RedisLabs/rejson-py/badge.svg?branch=master
-    :target: https://coveralls.io/github/RedisLabs/rejson-py?branch=master
+[![Mailing List](https://img.shields.io/badge/Mailing%20List-RedisJSON-blue)](https://groups.google.com/forum/#!forum/redisjson)
+[![Gitter](https://badges.gitter.im/RedisLabs/RedisJSON.svg)](https://gitter.im/RedisLabs/RedisJSON?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 rejson-py is a package that allows storing, updating and querying objects as
-JSON documents in a `Redis`_ database that is extended with the
-`ReJSON module`_. The package extends
-`redis-py`_'s interface with ReJSON's
+JSON documents in a [Redis](https://redis.io) database that is extended with the
+[ReJSON module](https://github.com/redislabsmodules/rejson). The package extends
+[redis-py](https://github.com/andymccurdy/redis-py)'s interface with ReJSON's
 API, and performs on-the-fly serialization/deserialization of objects to/from
 JSON.
 
-.. _`Redis`: https://redis.io
-.. _`ReJSON module`: https://github.com/redislabsmodules/rejson
-.. _`redis-py`: https://github.com/andymccurdy/redis-py
-
-Installation
-------------
-
-.. code-block:: bash
-
-   $ pip install rejson
+## Installation
 
-Usage example
--------------
+```bash
+$ pip install rejson
+```
 
-.. code-block:: python
+## Usage example
 
+```python
    from rejson import Client, Path
 
    rj = Client(host='localhost', port=6379, decode_responses=True)
@@ -81,23 +65,19 @@ Usage example
    }
    rj.jsonset('non-ascii', Path.rootPath(), obj_non_ascii)
    print '{} is a non-ascii string'.format(rj.jsonget('non-ascii', Path('.non_ascii_string'), no_escape=True))
+```
 
-Encoding/Decoding
------------------
+## Encoding/Decoding
 
-rejson-py uses Python's json_.
+rejson-py uses Python's (json)[https://docs.python.org/2/library/json.html].
 The client can be set to use custom encoders/decoders at creation, or by calling
-explicitly the setEncoder_ () and
-setDecoder_ () methods, respectively.
-
-.. _json: https://docs.python.org/2/library/json.html
-.. _setDecoder: ./API.md#setdecoder
-.. _setEncoder: ./API.md#setencoder
+explicitly the [setEncoder()](./API.md#setencoder) and
+[setDecoder()](./API.md#setencoder) methods, respectively.
 
 The following shows how to use this for a custom class that's stored as
 a JSON string for example:
 
-.. code-block:: python
+```python
 
    from json import JSONEncoder, JSONDecoder
    from rejson import Client
@@ -149,28 +129,21 @@ a JSON string for example:
 
    # Retrieve it
    obj = rj.jsonget('custom', Path.rootPath())
+```
 
-
-API
----
+## API
 
 As rejson-py exposes the same methods as redis-py, it can be used as a drop-in
 replacement. On top of Redis' core commands, the client also adds ReJSON's
 vocabulary and a couple of helper methods. These are documented in the
 [API.md](API.md) file, which can be generated by running:
 
-.. code-block:: bash
-
-   $ python gendoc rejson > API.md
-
-
-For complete documentation about ReJSON's commands, refer to `ReJSON's website`_.
-
-.. _`ReJSON's website`: http://rejson.io
+```bash
+$ python gendoc rejson > API.md
+```
 
-License
--------
+For complete documentation about ReJSON's commands, refer to [ReJSON's website](http://rejson.io).
 
-`BSD 2-Clause`_
+## License
 
-.. _`BSD 2-Clause`: https://github.com/RedisLabs/rejson-py/blob/master/LICENSE
+[BSD 2-Clause](https://github.com/RedisLabs/rejson-py/blob/master/LICENSE)

setup.py

@@ -34,7 +34,7 @@ def read_all(f):
 setup(name='rejson',
       version=version,
       description='ReJSON Python Client',
-      long_description=read_all("README.rst"),
+      long_description=read_all("README.md"),
       long_description_content_type='text/markdown',
       classifiers=[
             'Programming Language :: Python',