diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f6a9f0e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2016 Stephen Radford + +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: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +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. diff --git a/README.md b/README.md index 95f23db..afe3d2d 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ sudo npm install -g --unsafe-perm homebridge ### Config + Running -Check the `config-sample.json` for an example on how to configure the plugin. +Check the `config-sample.json` for an example on how to configure the plugin. You can configure as many buttons as you wish. Homebridge **must** be run with elevated privileges to work correctly i.e. sudo or root. diff --git a/config-sample.json b/config-sample.json new file mode 100644 index 0000000..ea814c9 --- /dev/null +++ b/config-sample.json @@ -0,0 +1,25 @@ +{ + "bridge": { + "name": "Homebridge", + "username": "DC:39:3D:F3:CE:31", + "port": 51827, + "pin": "031-57-155" + }, + + "description": "An example Homebridge config for Amazon Dash.", + + "accessories": [ + { + "accessory": "Dash", + "name": "Dash Button 1", + "protocol": "udp", + "mac": "XX:XX:XX:XX:XX:XX" + }, + { + "accessory": "Dash", + "name": "Another Dash", + "protocol": "udp", + "mac": "XX:XX:XX:XX:XX:XX" + } + ] +}