From 6935b6deff1a1f141f9767d62daa765c8d6e7fb5 Mon Sep 17 00:00:00 2001 From: Jack Wilsdon Date: Thu, 5 May 2016 11:41:18 +0100 Subject: [PATCH] Add configuration documentation for bpm plugin --- docs/plugins/bpm.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/plugins/bpm.rst b/docs/plugins/bpm.rst index ce1f62298..f622ebc8d 100644 --- a/docs/plugins/bpm.rst +++ b/docs/plugins/bpm.rst @@ -22,6 +22,20 @@ for instance, with ``mpc`` you can do something like:: beet bpm $(mpc |head -1|tr -d "-") +Configuration +------------- + +To configure the plugin, make a ``bpm:`` section in your configuration file. +The available options are: + +- **max_strokes**: The maximum number of strokes to accept when tapping out the + BPM. + Default: 3. +- **overwrite**: Overwrite the track's existing BPM. + Default: ``yes``. +- **write**: Write the song's tags to file when the BPM is updated. + Default: ``no``. + Credit ------