Fix typos in absubmit documentation

This commit is contained in:
inytar 2016-12-31 14:12:28 -05:00
parent cfe9c0f3d4
commit 9ab67d5ffe

View file

@ -1,23 +1,23 @@
AcousticBrainz Submit Plugin
============================
The `absubmit` plugin uses the `streaming_extractor_music`_ program to analyse an audio file and calculate different acoustic properties of the audio, the plugin then uploads this metadata to the AcousticBrainz server. The plugin does this when calling the ``beet absumbit [QUERY]`` command or on importing if the `auto` configuration options is set to ``yes``.
The `absubmit` plugin uses the `streaming_extractor_music`_ program to analyse an audio file and calculate different acoustic properties of the audio. The plugin then uploads this metadata to the AcousticBrainz server. The plugin does this when calling the ``beet absumbit [QUERY]`` command or on importing if the `auto` configuration option is set to ``yes``.
Installation
------------
The `absubmit` plugin requires the the `streaming_extractor_music`_ program to run. Its source can be found on `github`_, and while it is possible to compile the extractor from source, AcousticBrainz would prefer if you used thier binary (see the AcousticBrainz `FAQ`_).
The `absubmit` plugin requires the `streaming_extractor_music`_ program to run. Its source can be found on `GitHub`_, and while it is possible to compile the extractor from source, AcousticBrainz would prefer if you used thier binary (see the AcousticBrainz `FAQ`_).
The `absubmit` also plugin requires `requests`_, which you can install using `pip_` by typing:
pip install requests
After installing both the extractor binary and request you can enable the plgin ``absubmit`` in your configuration (see :ref:`using-plugins`).
After installing both the extractor binary and requests you can enable the plugin ``absubmit`` in your configuration (see :ref:`using-plugins`).
Configuration
-------------
To configute the plugin, make a ``absubmit:`` section in your configuration file. The available options are:
To configure the plugin, make a ``absubmit:`` section in your configuration file. The available options are:
- **auto**: Analyze every file on import. Otherwise, you need to use the ``beet absubmit`` command explicitly.
Default: ``no``