beets/docs/plugins/mbcollection.rst
Fabrice Laporte cb350de2ea harmonize all plugins docs
Add a configuration section that lists all options for each plugin.
List options in alphabetic order.
Mention the default value for each option.
Use same sentences to describe concepts common to different plugins eg 'auto
option, install description
2014-10-26 22:29:10 +01:00

31 lines
1 KiB
ReStructuredText

MusicBrainz Collection Plugin
=============================
The ``mbcollection`` plugin lets you submit your catalog to MusicBrainz to
maintain your `music collection`_ list there.
.. _music collection: http://musicbrainz.org/doc/Collections
To begin, just enable the ``mbcollection`` plugin in your
configuration (see :ref:`using-plugins`).
Then, add your MusicBrainz username and password to your
:doc:`configuration file </reference/config>` under a ``musicbrainz`` section::
musicbrainz:
user: you
pass: seekrit
Then, use the ``beet mbupdate`` command to send your albums to MusicBrainz. The
command automatically adds all of your albums to the first collection it finds.
If you don't have a MusicBrainz collection yet, you may need to add one to your
profile first.
Configuration
-------------
Automatically Update on Import
------------------------------
mbcollection: if set to ``yes``, the plugin will automatically amend your
MusicBrainz collection whenever you import a new album. Default: ``false``