From b9e58e8bccb4e57f43aaf9512cf7476556a4e2a2 Mon Sep 17 00:00:00 2001 From: James Barnsley Date: Sun, 22 Aug 2021 09:16:08 +1200 Subject: [PATCH] Adding reStructuredText readme --- README.rst | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..294d690e --- /dev/null +++ b/README.rst @@ -0,0 +1,49 @@ +Iris +#### + +Iris is an extension for the Mopidy music server. With support for Spotify, LastFM, Genius, Snapcast and many other extensions, Iris brings all your music into one user-friendly and unified web-based interface that works beautifully, no matter your device. + +Built and maintained by James Barnsley. + +.. image:: https://static.pepy.tech/personalized-badge/mopidy-iris?period=total&units=international_system&left_color=grey&right_color=green&left_text=Downloads + :target: https://pepy.tech/project/mopidy-iris +.. image:: https://img.shields.io/pypi/v/mopidy-iris.svg?style=flat-square + :target: https://pypi.org/project/Mopidy-Iris/ +.. image:: https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square + :target: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=james%40barnsley%2enz&lc=NZ&item_name=James%20Barnsley¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted + +Features +******** + +- Full web-based interface controls for Mopidy +- Improved support for local libraries (powered by Mopidy-Local) +- Browse and manage your playlists and tracks +- Discover new, popular and related music (powered by Spotify) +- Multiple language support. `Want to provide a translation? `_ +- Streaming controls with the ability to play audio from your browser (requires Snapcast) + +Integrations +************ + +- `Spotify `_ +- `LastFM `_ for rich music metadata and artwork +- `Genius `_ for lyrics +- `Snapcast `_ to stream audio to multiple devices + +.. image:: https://raw.githubusercontent.com/jaedb/Iris/master/screenshot.jpg + + +Requirements +************ + +- Mopidy +- Mopidy-Spotify (recommended, not required) +- Mopidy-Local (recommended, not required) + +Getting started +*************** + +- `Installation `_ +- `Debugging `_ +- `Issues and requests `_ +- `Changelog `_