From dcce29eeb32803e745503b362ea1cc9a845d61a4 Mon Sep 17 00:00:00 2001 From: Tobias Sauerwein Date: Fri, 20 Apr 2018 00:07:40 +0200 Subject: [PATCH] Add documentation for the sonos updater plugin. --- docs/plugins/sonosupdate.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/plugins/sonosupdate.rst diff --git a/docs/plugins/sonosupdate.rst b/docs/plugins/sonosupdate.rst new file mode 100644 index 000000000..1ecf91b92 --- /dev/null +++ b/docs/plugins/sonosupdate.rst @@ -0,0 +1,23 @@ +SonosUpdate Plugin +================= + +The ``sonosupdate`` plugin lets you automatically update `Sonos`_'s music +library whenever you change your beets library. + +To use ``sonosupdate`` plugin, enable it in your configuration +(see :ref:`using-plugins`). + +To use the ``sonosupdate`` plugin you need to install the `soco`_ library with:: + + pip install soco + +With that all in place, you'll see beets send the "update" command to your Sonos +controller every time you change your beets library. + +.. Sonos: http://sonos.com/ +.. _soco: http://python-soco.com + +Configuration +------------- + +There is nothing to configure.