Skip to content

Commit 38cdcfe

Browse files
committed
docs: clarify installation docs
1 parent 3a19664 commit 38cdcfe

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

docs/index.rst

+19-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,22 @@ This is a plugin for Moe utilizing the musicbrainz metadata source and provides
77
* Update musicbrainz collections automatically on import or manually.
88
* Various API functions.
99

10+
************
11+
Installation
12+
************
13+
1. Install via pip
14+
15+
.. code-block:: bash
16+
17+
$ pip install moe_musicbrainz
18+
19+
*************
1020
Configuration
11-
=============
21+
*************
22+
Add ``musicbrainz`` to the ``enabled_plugins`` configuration option.
23+
24+
This plugin has the following configuration options:
25+
1226
``username``
1327
Musicbrainz username.
1428
``password``
@@ -36,8 +50,9 @@ The following options involve auto updating a specific collection on musicbrainz
3650
``auto_remove = False``
3751
Whether to automatically remove releases from ``collection_id`` when removed from the library.
3852

53+
*************
3954
Custom Fields
40-
=============
55+
*************
4156
This plugin adds the following custom fields:
4257

4358
Track Fields
@@ -48,8 +63,9 @@ Album Fields
4863
~~~~~~~~~~~~
4964
* ``mb_album_id`` - musicbrainz album aka release id
5065

66+
**********************
5167
Command-line Interface
52-
======================
68+
**********************
5369
This plugin adds the following commands:
5470

5571
mbcol

0 commit comments

Comments
 (0)