docs: Add badges, install instructions, etc

README.md

@@ -1,39 +0,0 @@
-# Mopidy Subidy
-
-A subsonic backend for mopidy using [py-sub](https://github.com/crustymonkey/py-sonic).
-
-## Configuration
-
-Add a section similiar to the following to your mopidy configuration:
-
-```ini
-[subidy]
-enabled=True
-url=https://path.to/your/subsonic/server
-username=subsonic_username
-password=your_secret_password
-legacy_auth=(optional - setting to yes may solve some connection errors)
-api_version=(optional - specify which API version to use. Subsonic 6.2 uses 1.14.0)
-```
-
-## State of this plugin
-
-Plugin is developed against mopidy version 2.0.1.
-
-The following things are supported:
-
- * Browsing all artists/albums/tracks
- * Searching for any terms
- * Browsing, creating, editing and deleting playlists
- * Searching explicitly for one of: artists, albums, tracks
-
-The following things are **not** supported:
-
-  * Subsonics smart playlists
-  * Searching for a combination of filters (artist and album, artist and track, etc.)
-
-## Contributors
-
-The following people contributed to this project:
- - Frederick Gnodtke
- - hhm0

README.rst

@@ -0,0 +1,79 @@
+*************
+Mopidy-Subidy
+*************
+
+.. image:: https://img.shields.io/pypi/v/Mopidy-Subidy
+    :target: https://pypi.org/project/Mopidy-Subidy/
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/circleci/build/gh/Prior99/mopidy-subidy
+    :target: https://circleci.com/gh/Prior99/mopidy-subidy
+    :alt: CircleCI build status
+
+.. image:: https://img.shields.io/codecov/c/gh/Prior99/mopidy-subidy
+    :target: https://codecov.io/gh/Prior99/mopidy-subidy
+    :alt: Test coverage
+
+A Subsonic backend for Mopidy using `py-sonic
+<https://github.com/crustymonkey/py-sonic>`_.
+
+
+Installation
+============
+
+Install the latest release from PyPI by running::
+
+    python3 -m pip install Mopidy-Subidy
+
+Install the development version directly from this repo by running::
+
+    python3 -m pip install https://github.com/Prior99/mopidy-subidy/archive/master.zip
+
+See https://mopidy.com/ext/subidy/ for alternative installation methods.
+
+
+Configuration
+=============
+
+Before starting Mopidy, you must add configuration for Mopidy-Subidy to your
+Mopidy configuration file::
+
+   [subidy]
+   url=https://path.to/your/subsonic/server
+   username=subsonic_username
+   password=your_secret_password
+
+In addition, the following optional configuration values are supported:
+
+- ``enabled`` -- Defaults to ``true``. Set to ``false`` to disable the
+  extension.
+
+- ``legacy_auth`` -- Defaults to ``false``. Setting to ``true`` may solve some
+  connection errors.
+
+- ``api_version`` -- Defaults to ``1.14.0``, which is the version used by
+  Subsonic 6.2.
+
+
+State of this plugin
+====================
+
+The following things are supported:
+
+- Browsing all artists/albums/tracks
+- Searching for any terms
+- Browsing, creating, editing and deleting playlists
+- Searching explicitly for one of: artists, albums, tracks
+
+The following things are **not** supported:
+
+- Subsonic's smart playlists
+- Searching for a combination of filters (artist and album, artist and track, etc.)
+
+
+Credits
+=======
+
+- Original author: `Frederick Gnodtke <https://github.com/Prior99>`__
+- Current maintainer: `Frederick Gnodtke <https://github.com/Prior99>`__
+- `Contributors <https://github.com/Prior99/mopidy-subidy/graphs/contributors>`_

setup.cfg

@@ -7,8 +7,7 @@ author_email = fgnodtke@cronosx.de
 license = BSD-3-Clause
 license_file = LICENSE
 description = Subsonic extension for Mopidy
-long_description = file: README.md
-long_description_content_type = text/markdown
+long_description = file: README.rst
 classifiers =
     Environment :: No Input/Output (Daemon)
     Intended Audience :: End Users/Desktop