Merge pull request #1 from jodal/improve-readme
Improve README
Janez Troha
11 years ago
| 0 | 0 | Mopidy-Beets |
| 1 | ================= | |
| 1 | ============ | |
| 2 | 2 | |
| 3 | Mopidy http://www.mopidy.com/ extension for playing music from | |
| 4 | Beets http://beets.radbox.org/ via beets web extension. | |
| 3 | `Mopidy <http://www.mopidy.com/>`_ extension for playing music from | |
| 4 | `Beets <http://beets.radbox.org/>`_ via Beets' web extension. | |
| 5 | 5 | |
| 6 | 6 | Usage |
| 7 | 7 | ----- |
| 8 | 8 | |
| 9 | Install by running:: | |
| 9 | #. Setup the `Beets web plugin | |
| 10 | <http://beets.readthedocs.org/en/latest/plugins/web.html>`_. | |
| 11 | ||
| 12 | #. Install the Mopidy-Beets extension by running:: | |
| 10 | 13 | |
| 11 | 14 | sudo pip install mopidy-beets |
| 12 | 15 | |
| 13 | ||
| 14 | Setup your beets host | |
| 16 | #. Tell Mopidy where to find the Beets web interface by adding the following to | |
| 17 | your ``mopidy.conf``:: | |
| 15 | 18 | |
| 16 | 19 | [beets] |
| 17 | 20 | hostname = 127.0.0.1 |
| 18 | 21 | port = 8888 |
| 19 | 22 | |
| 23 | #. Restart Mopidy. | |
| 24 | ||
| 25 | #. Searches in Mopidy will now return results from your Beets library. | |
| 20 | 26 | |
| 21 | 27 | |
| 22 | 28 | Project resources |
| 23 | 29 | ----------------- |
| 24 | 30 | |
| 25 | - Source code https://github.com/dz0ny/mopidy-beets_ | |
| 26 | - Issue tracker https://github.com/mopidy/mopidy-beets/issues | |
| 27 | - Download development snapshot https://github.com/dz0ny/mopidy-beets/tarball/develop#egg=mopidy-beets-dev | |
| 28 | ||
| 29 | License | |
| 30 | ------- | |
| 31 | ||
| 32 | Copyright (C) 2013 <dz0ny at shortmail dot com> | |
| 33 | ||
| 34 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | |
| 35 | ||
| 36 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |
| 37 | ||
| 38 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
| 31 | - `Source code <https://github.com/dz0ny/mopidy-beets>`_ | |
| 32 | - `Issue tracker <https://github.com/mopidy/mopidy-beets/issues>`_ | |
| 33 | - `Download development snapshot | |
| 34 | <https://github.com/dz0ny/mopidy-beets/tarball/develop#egg=mopidy-beets-dev>`_ |