Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
fmatray committed Apr 15, 2020
1 parent 968ab84 commit 14e09c9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
16 changes: 13 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Mopidy-NeoPixel
:target: https://codecov.io/gh/fmatray/mopidy-neopixel
:alt: Test coverage

We always can add leds
We always can add leds to mopidy players.


Installation
Expand All @@ -33,9 +33,19 @@ Configuration
Before starting Mopidy, you must add configuration for
Mopidy-NeoPixel to your Mopidy configuration file::

[neopixel]
# TODO: Add example of extension config
[neopixel]
enabled = true
#Led Pin. You can only use pins 10, 12, 18 or 21
pin = 12
# Number of leds
nb_leds = 7

Limitations
===========

Mopidy MUST run as root to have access to /dev/mem.
As long as you don't use this plugin to rule a sattelite or a WMD, it should be ok :-)
Keep this for a small personnal project.

Project resources
=================
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ def get_version(filename):
packages=find_packages(exclude=['tests', 'tests.*']),
zip_safe=False,
include_package_data=True,
keywords = ['Mopidy', 'Mopidy-frontend', 'Neopixels'],
download_url='https://github.com/fmatray/mopidy-neopixel/archive/0.1.0.zip',
keywords=['Mopidy', 'Mopidy-frontend', 'Neopixels'],
install_requires=[
'setuptools',
'Mopidy >= 0.14',
Expand Down

0 comments on commit 14e09c9

Please sign in to comment.